Skip to main content
PUT
Update the default workflow configuration

Authorizations

Authorization
string
header
required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Headers

x-idempotency-key
string<uuid>
required

Idempotency key to be used. Sending again the same key would return the same result without re-executing the update.

Path Parameters

workflowCode
string
required

Path parameter to specify the workflow code. Machine-friendly code of Workflow.

Pattern: ^[a-z][-A-Za-z0-9]*$

Body

application/json
version
integer

Version of a Workflow Configuration.

workspaceId
string<uuid>

The workspace id corresponding to the default workflow configuration.

versions
object[]

Rollout configuration for traffic splitting across multiple versions. If provided, weights must sum to 100 and each entry must be between 1 and 100.

Response

New default version set.

workflowCode
string
required

The workflow code this default version applies to.

Pattern: ^[a-z][-A-Za-z0-9]*$
version
integer
required

The config version which will be used for newly created executions.

createdAt
string<date-time>
required

When a version was first set as the default for this workflow.

updatedAt
string<date-time>
required

When this version was set as the default version.

workspaceId
string<uuid>

Workspace ID that the workflow configuration belongs to.

updatedBy
string | null

User email who set this workflow version as default.

versions
object[]

Current rollout configuration for traffic splitting between versions.

Last modified on October 1, 2026