Check whether the workflow template is ready for execution

GET

client

workflows

{workflow_id}

template-readiness

Check whether the workflow template is ready for execution

curl --request GET \
  --url http://localhost:8080/api/v1/client/workflows/{workflow_id}/template-readiness \
  --header 'Authorization: <api-key>'

{
  "data": {
    "issues": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "ready": true,
    "template_assigned": true,
    "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

Response

data

object

Show child attributes

errors

object[]

Show child attributes

message

string

Example:

"Operation successful"

meta

object

success

boolean

Example:

true

Patch client workflow customizationUpdate per-client workflow overrides (template, delay, priority, send time mode/hour/minute) with validation and audit logging.

⌘I

Check whether the workflow template is ready for execution

curl --request GET \
  --url http://localhost:8080/api/v1/client/workflows/{workflow_id}/template-readiness \
  --header 'Authorization: <api-key>'

{
  "data": {
    "issues": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "ready": true,
    "template_assigned": true,
    "template_id": 123
  },
  "errors": [
    {
      "condition": "format",
      "error": "Invalid email format",
      "key": "email"
    }
  ],
  "message": "Operation successful",
  "meta": {},
  "success": true
}