Skip to main content
POST
workflow.schedule.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
workflowId
string
required

The identifier of a workflow defined in your own account or code.

Required string length: 1 - 256
Pattern: ^[A-Za-z0-9_.:-]+$
cron
string
required

Five-field cron expression defining the schedule.

Required string length: 1 - 256
Pattern: ^[0-9A-Za-z*?,/\-# L]+$
timezone
string
default:UTC

IANA timezone, for example Europe/London or UTC.

Required string length: 1 - 100
externalKey
string

Your optional external schedule label.

Required string length: 1 - 256

Response

The result

scheduleId
string
required

A schedule identifier in your connected account.

Required string length: 1 - 256
Pattern: ^[A-Za-z0-9_.:-]+$
workflowId
string
required

The identifier of a workflow defined in your own account or code.

Required string length: 1 - 256
Pattern: ^[A-Za-z0-9_.:-]+$
kind
enum<string>
required

Defined in code, or managed through the API.

Available options:
code,
managed
active
boolean
required

Whether future runs are enabled.

cron
string
required

Five-field cron expression defining the schedule.

Required string length: 1 - 256
Pattern: ^[0-9A-Za-z*?,/\-# L]+$
timezone
string
required

IANA timezone, for example Europe/London or UTC.

Required string length: 1 - 100
created
boolean
required

The schedule change was confirmed.

nextRunAt
string<date-time>

Next scheduled run in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
minimumIntervalSeconds
number

Minimum interval enforced by your account plan, in seconds.

Required range: x >= 0