Update a deployment | Neobits API Documentation

patchUpdate a deployment

Partially updates a deployment in the active workspace. Supply at least one of decisionId, version, environmentId, name, message, or deployedBy. Omitted fields remain unchanged; null clears message or selects the working copy for version. Resulting environment and decision references are validated. This updates the deployment record only; it does not recreate or change its routing. Create a new deployment to activate another version with immediate full-traffic routing.

Required service-token scope: deployment:update. End-user access is checked against workspace policies. Send a Bearer token and the X-Workspace-Id header.

curl --request PATCH \
  --url https://api.test.neobits.ai/logic/v1/deployments/019991b1-0000-7000-8000-000000000004 \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'X-Workspace-Id: 019991b1-0000-7000-8000-000000000001' \
  --header 'Content-Type: application/json' \
  --data '{"message":"Verified by integration tests"}'

Request

Headers

Authorization•string
Bearer token authentication using OAuth 2.0 client credentials flow.
Required
X-Workspace-Id•string<uuid>
Active workspace UUID. The authenticated principal must have access to this workspace.
Required

Params (path)

id•string<uuid>
Deployment identifier.
Required

Body

decisionId•string<uuid>
Standalone decision to deploy. Sub-decisions are deployed with their parent.
version•integer
Saved version number, or 0/null for the working copy. Null is normalized to 0 in the response. Use a saved version for a reproducible deployment.
Nullable
environmentId•string<uuid>
Environment in the active workspace.
name•string
Nonempty deployment name without leading or trailing whitespace.
message•string
Release notes. Use null or an empty string to clear them.
Nullable
deployedBy•string
Caller-supplied attribution; required and not inferred from the access token.

Response

Headers

Content-Type•string
The content type of the response.

Body

id•string<uuid>
Deployment identifier.
Required
workspaceId•string<uuid>
Workspace containing this resource.
Required
decisionId•string<uuid>
Standalone decision to deploy. Sub-decisions are deployed with their parent.
Required
version•integer
Saved version number, or 0/null for the working copy. Null is normalized to 0 in the response. Use a saved version for a reproducible deployment.
RequiredNullable
environmentId•string<uuid>
Environment in the active workspace.
Required
name•string
Nonempty deployment name without leading or trailing whitespace.
Required
message•string
Release notes. Use null or an empty string to clear them.
RequiredNullable
deployedBy•string
Caller-supplied attribution; required and not inferred from the access token.
Required
milestone•integer
Snapshot milestone; always 0 for a deployment.
Required
createdAt•string<date-time>
Creation time.
Required
updatedAt•string<date-time>
Last update time.
Required