PUT /accounts/{account_id}/workflows/{workflow_name}

Creates a new workflow or updates an existing workflow definition.

Servers

Path parameters

Name Type Required Description
account_id String Yes
workflow_name String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
concurrency Object No
concurrency.limit Integer No

Maximum number of instances of this workflow that can run concurrently. Additional instances are queued and started as running instances complete. Must not exceed the account concurrency limit.

default_retention Object No

Default retention applied to instances of this version when they do not set their own retention.

default_retention.error_retention String No

Specifies the duration in milliseconds or as a string like '5 minutes'.

default_retention.success_retention String No

Specifies the duration in milliseconds or as a string like '5 minutes'.

script_name String Yes
class_name String Yes
schedules[] Array No
schedules[].cron String Yes
limits Object No
limits.steps Integer No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.