Update Deployment Version

Rename or describe a deployment version, or make it the active version with `isActive: true`. Activating rolls the deployment back or forward to that version without changing the saved workflow. Editing the name or description needs write access (a write grant for scoped keys). Activating needs admin access (an admin grant for scoped keys).

PATCH/api/workflows/{id}/deployments/{version}

Authorization

apiKey
X-API-Key<token>

Your SteelEngine API key (personal, workspace, or organization). Create personal and workspace keys under Settings > API Keys. Create organization keys under Organization Settings > API Keys.

In: header

Path Parameters

id*string

The unique identifier of the workflow.

version*integer

The deployment version number, as listed by List Deployments.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

At least one field is required.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/workflows/string/deployments/0" \  -H "Content-Type: application/json" \  -d '{}'
{  "success": true,  "deployedAt": "2026-10-21T15:04:05.000Z",  "warnings": []}