Skip to main content
POST
Create a scheduler

Authorizations

X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Body

application/json
type
enum<string>
required
write-only

Scheduler type; only recurring is allowed for creation

Available options:
recurring
Example:

"recurring"

name
string | null
write-only

Scheduler name; if omitted, the scheduler is created without a name

Example:

"Daily Invoices Scheduler"

isEnabled
boolean
default:true
write-only

Whether the scheduler is enabled

Example:

true

tags
string<iri-reference>[]
write-only

Entity tags to associate with the scheduler

Example:

Response

Scheduler resource response

@context
string
default:/contexts/Scheduler
@id
string<iri-reference>

Scheduler IRI reference

Example:

"/schedulers/91106968-1abd-4d64-85c1-4e73d96fb997"

@type
string
default:Scheduler

JSON-LD resource type

id
string<uuid>
Example:

"e0a24894-7fbf-48ae-bfb0-efaae30a6319"

name
string | null

Scheduler name; may be null for first-time schedulers created automatically by the platform

Example:

"Daily Invoices Scheduler"

type
enum<string>

Scheduler type

Available options:
recurring
Example:

"recurring"

isEnabled
boolean

Whether the scheduler is enabled

Example:

true

rules
object
tags
object[]
createdAt
string

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

updatedAt
string

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"