Skip to main content
POST
queue.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
url
string
required

Your public HTTPS delivery URL, without credentials or private hosts.

body
string
required

Message body, at most 1 MiB in UTF-8 bytes.

cron
string
required

Five-field cron expression in UTC, at minute resolution.

Maximum string length: 128
Pattern: ^[0-9*,/-]+(?: [0-9*,/-]+){4}$
headers
object

At most 20 delivery headers: content-type, authorization, accept, x-request-id, x-correlation-id, x-event-type, x-signature or x-trace-id.

retries
integer
default:3

Delivery retries, 0 to 5; costs are billed by your connected account.

Required range: 0 <= x <= 5

Response

The result

ref
string

Reference to what this call created. Pass it as ref to queue.schedule.get, queue.schedule.delete.

nextRunAt
string<date-time>

Next delivery time in UTC, when supplied.

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))$