Schedule APIs

These APIs are in beta

The schedule APIs are in beta and may have future breaking changes.

The schedule APIs allow you to manage and interact with schedules within your Omni organization.

Trigger schedule

Triggers the execution of a schedule on demand, outside of its regular schedule.

Basic request

POST /api/unstable/schedules/:scheduleId/trigger

curl -X POST 'https://myorg.omniapp.co/api/unstable/schedules/123e4567-e89b-12d3-a456-426614174000/trigger' \
--H 'Authorization: Bearer <TOKEN>'

Parameters

Note: The scheduleId must be provided as a path parameter.

Loading parameters...

Response

200 OK

Successful requests will return a 200 OK status and a response body similar to the following:

{
  "success": true
}

Field	Type	Description
success	boolean	Indicates schedule has been triggered successfully

400 Bad Request

{
  "detail": "<errorReason>",
  "status": 400
}

Issue	Error detail
Invalid UUID format	Bad Request: scheduleId: Invalid uuid
Invalid method	Invalid method

404 Not Found

{
  "detail": "<errorReason>",
  "status": 404
}

Issue	Error detail
Schedule not found	Scheduled task with id {scheduleId} does not exist

429 Too Many Requests

Results from too many requests in a given time frame. Refer to the Rate limiting documentation for more information.

500 Internal Server Error

{
  "detail": "<errorReason>",
  "status": 500
}

Issue	Error detail
Dispatcher error	Various error messages related to dispatch failures

Add recipients to schedule

Adds one or more recipients to an existing scheduled task.

Basic request

POST /api/unstable/schedules/:scheduleId/add-recipients

curl -X POST 'https://myorg.omniapp.co/api/unstable/schedules/123e4567-e89b-12d3-a456-426614174000/add-recipients' \
--H 'Authorization: Bearer <TOKEN>' \
--H 'Content-Type: application/json' \
--d '{
  "recipients": "987fcdeb-51a2-43d7-9b56-254415f67890"
}'

Multiple recipients

POST /api/unstable/schedules/:scheduleId/add-recipients

curl -X POST 'https://myorg.omniapp.co/api/unstable/schedules/123e4567-e89b-12d3-a456-426614174000/add-recipients' \
--H 'Authorization: Bearer <TOKEN>' \
--H 'Content-Type: application/json' \
--d '{
  "recipients": "987fcdeb-51a2-43d7-9b56-254415f67890,abcdef12-3456-7890-abcd-ef1234567890"
}'

Parameters

Loading parameters...

Response

200 OK

Successful requests will return a 200 OK status and a response body similar to the following:

{
  "success": true
}

Field	Type	Description
success	boolean	Indicates recipients have been added successfully

400 Bad Request

{
  "detail": "<errorReason>",
  "status": 400
}

Issue	Error detail
Invalid UUID format	Bad Request: scheduleId: Invalid uuid
Missing recipients	Bad Request: recipients: recipients is required
Invalid recipient IDs	Bad Request: recipients: All recipient IDs must be valid UUIDs
Invalid members	Invalid recipient(s): The following members do not exist or do not have access to this organization: {userId}
Unsupported destination	Cannot add recipients to destination type {destinationType}

404 Not Found

{
  "detail": "<errorReason>",
  "status": 404
}

Issue	Error detail
Schedule not found	Scheduled task with id {scheduleId} does not exist

429 Too Many Requests

Results from too many requests in a given time frame. Refer to the Rate limiting documentation for more information.