Turn a workflow on or off

POST

/api/v1/automations/workflows/{id}/status

curl --request POST \
  --url https://digize.com/api/v1/automations/workflows/example/status \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "status": "active" }'

• Digize

Makes a workflow active, after checking it can run, or pauses it. A pause holds runs waiting in it until it’s active again.

Needs the automations:write permission.

Authorizations

• apiKey
• bearer

Parameters

Path Parameters

id

required

string

>= 1 characters <= 64 characters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Body^required

Media typeapplication/json

object

status

required

string

Allowed values: active paused

Responses

200

Done

Media typeapplication/json

object

id

required

string

name

required

string

description

required

string

status

required

Active runs on its trigger; paused holds waiting runs; draft never runs.

string

Allowed values: active paused draft

nodes

required

Array<object>

<= 100 items

object

id

required

string

>= 1 characters <= 64 characters

type

required

The kind of node, such as trigger.form_submitted or action.send_sms.

string

Allowed values: trigger.form_submitted trigger.order_paid trigger.order_refunded trigger.checkout_expired trigger.booking_created trigger.message_received trigger.schedule trigger.webhook action.send_sms action.send_email flow.wait flow.if flow.switch crm.update_contact crm.add_tag crm.create_opportunity app.http_request app.code app.slack_message app.sheets_row

name

required

Unique in the workflow, so expressions can name it: $(‘Wait a day’).

string

<= 60 characters

position

required

object

x

required

number

y

required

number

params

required

The node’s settings, as the catalog defines them.

object

key

additional properties

Any of:

string

string

number

number

boolean

boolean

null

null

Array

Array<object> recursive

object

object

key

additional properties

object recursive

disabled

boolean

settings

object

onError

string

Allowed values: stop continue

retries

integer

<= 5

notes

string

<= 2000 characters

edges

required

Array<object>

<= 300 items

object

id

required

string

>= 1 characters <= 200 characters

source

required

string

>= 1 characters <= 64 characters

sourceHandle

required

Main, or true/false for If, or a path’s id for Switch.

string

>= 1 characters <= 64 characters

target

required

string

>= 1 characters <= 64 characters

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

stats

required

object

runs

required

Runs in the last 30 days, tests left out.

number

completed

required

number

failed

required

number

lastRunAt

required

Any of:

string

string format: date-time

null

null

Example

{
  "status": "active",
  "nodes": [
    {
      "type": "trigger.form_submitted",
      "settings": {
        "onError": "stop"
      }
    }
  ]
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

422

The Idempotency-Key was used with a different request.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}