Patch client workflow customization

PATCH

client

workflows

{workflow_id}

customization

Patch client workflow customization

curl --request PATCH \
  --url http://localhost:8080/api/v1/client/workflows/{workflow_id}/customization \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "delay_minutes": 123,
  "preferred_send_hour": 123,
  "preferred_send_minute": 123,
  "priority_score": 123,
  "template_id": 123
}
'

{
  "data": {
    "delay_minutes": 123,
    "preferred_send_hour": 123,
    "preferred_send_minute": 123,
    "priority_score": 123,
    "template_id": 123
  },
  "errors": [
    {
      "condition": "format",
      "error": "Invalid email format",
      "key": "email"
    }
  ],
  "message": "Operation successful",
  "meta": {},
  "success": true
}

Authorizations

Authorization

string

header

required

JWT Bearer token or raw API key via Authorization header

Path Parameters

workflow_id

integer

required

Workflow ID

Body

application/json

Customization payload

delay_minutes

integer

preferred_send_hour

integer

preferred_send_minute

integer

priority_score

integer

send_time_mode

enum<integer>

Available options:

1,

2,

3,

4,

5

template_id

integer

Response

data

object

Show child attributes

errors

object[]

Show child attributes

message

string

Example:

"Operation successful"

meta

object

success

boolean

Example:

true

Run a queued execution immediatelyReset the scheduled time of a queued execution (and its queue item) to now. This response acknowledges the queue operation; use GET /client/executions/{execution_id} as the source of truth for final outcome state and reason.

⌘I

Patch client workflow customization

curl --request PATCH \
  --url http://localhost:8080/api/v1/client/workflows/{workflow_id}/customization \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "delay_minutes": 123,
  "preferred_send_hour": 123,
  "preferred_send_minute": 123,
  "priority_score": 123,
  "template_id": 123
}
'

{
  "data": {
    "delay_minutes": 123,
    "preferred_send_hour": 123,
    "preferred_send_minute": 123,
    "priority_score": 123,
    "template_id": 123
  },
  "errors": [
    {
      "condition": "format",
      "error": "Invalid email format",
      "key": "email"
    }
  ],
  "message": "Operation successful",
  "meta": {},
  "success": true
}