SchedulerController_create

POST

/sessions/{sessionId}/schedules

curl --request POST \
  --url https://example.com/sessions/example/schedules \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "templateId": "example", "phone": "example", "variables": { "additionalProperty": "example" }, "sendAt": "example", "recurring": true, "cronExpression": "example", "timezone": "example" }'

Authorizations

• apiKey
• bearerAuth

Parameters

Path Parameters

sessionId

required

string

Request Body^required

Media typeapplication/json

object

templateId

required

string

phone

required

string

variables

required

object

key

additional properties

string

sendAt

string

recurring

boolean

cronExpression

string

timezone

string

Example^generated

{
  "templateId": "example",
  "phone": "example",
  "variables": {
    "additionalProperty": "example"
  },
  "sendAt": "example",
  "recurring": true,
  "cronExpression": "example",
  "timezone": "example"
}

Responses

201

Media typeapplication/json

object

id

required

string

templateId

required

string

phone

required

string

variables

required

object

key

additional properties

string

sendAt

required

string

status

required

string

Allowed values: pending queued sent failed cancelled active

retryCount

number

sentAt

string

error

string

createdAt

required

string

updatedAt

required

string

recurring

boolean

cronExpression

string

nextRunAt

string

lastRunAt

string

runCount

number

Example

{
  "status": "pending"
}