Skip to main content
PATCH
/
workflow
/
{workflow_id}
Update Workflow
curl --request PATCH \
  --url https://api.getoutbox.ai/workflow/{workflow_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "active": true,
  "timezone": "<string>",
  "phone_number": "<string>",
  "email": "jsmith@example.com",
  "allowed_windows": null,
  "allow_reentry": true,
  "stop_on_response": true,
  "is_deleted": true,
  "actions": [
    {
      "order": 1073741823,
      "branch_index": -1,
      "config": "<unknown>",
      "is_deleted": true
    }
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "triggers": "<string>",
  "enrollment_count": "<string>",
  "total_enrollment_count": "<string>",
  "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "jarvis_conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "active": true,
  "timezone": "<string>",
  "phone_number": "<string>",
  "email": "jsmith@example.com",
  "allowed_windows": null,
  "allow_reentry": true,
  "stop_on_response": true,
  "is_deleted": true,
  "trigger": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "workflow": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "filters": "<unknown>",
    "config": "<unknown>"
  },
  "actions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parent_action_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "waiting_count": "<string>",
      "module_info": "<string>",
      "tools_info": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "workflow": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parent_action": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order": 1073741823,
      "branch_index": -1,
      "config": "<unknown>",
      "is_deleted": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workflow_id
string<uuid>
required

Body

​
name
string
Required string length: 1 - 128
​
description
string
​
active
boolean
​
timezone
string

Timezone for workflow scheduling (e.g., America/New_York)

Maximum string length: 64
​
phone_number
string

Default phone number ID (UUID) for workflow actions

Maximum string length: 36
​
email
string<email>

Default email for workflow actions

Maximum string length: 256
​
allowed_windows
unknown
​
allow_reentry
boolean
​
stop_on_response
boolean
​
is_deleted
boolean
​
trigger
object
​
actions
object[]

Response

​
id
string<uuid>
required
read-only
​
name
string
required
Maximum string length: 128
​
created_at
string<date-time>
required
read-only
​
updated_at
string<date-time>
required
read-only
​
triggers
string
required
read-only
​
enrollment_count
string
required
read-only
​
total_enrollment_count
string
required
read-only
​
folder_id
string<uuid> | null
required
read-only
​
jarvis_conversation_id
string<uuid> | null
required
read-only
​
description
string
​
active
boolean
​
timezone
string

Timezone for workflow scheduling (e.g., America/New_York)

Maximum string length: 64
​
phone_number
string

Default phone number ID (UUID) for workflow actions

Maximum string length: 36
​
email
string<email>

Default email for workflow actions

Maximum string length: 256
​
allowed_windows
unknown
​
allow_reentry
boolean
​
stop_on_response
boolean
​
is_deleted
boolean
​
trigger
object
​
actions
object[]