Skip to main content
POST
/
utils
/
schedules
Create a new schedule
curl --request POST \
  --url https://api.example.com/utils/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schedule_name": "<string>",
  "schedule": {
    "type": "<string>",
    "cron": "<string>",
    "timezone": "UTC"
  },
  "reference_id": "<string>",
  "config": {
    "type": "<string>",
    "topic": "<string>",
    "extra_data": {}
  },
  "enabled": true
}
'
{
  "schedule_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.emergence.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Project-ID
string | null

Body

application/json

Request body for creating a schedule.

schedule_name
string
required

Unique human readable name for the schedule

schedule
CronSchedule · object
required

Cron-based schedule configuration.

The cron expression is interpreted in the specified timezone. It will be converted to UTC for storage and execution.

reference_id
string
required

Reference ID (e.g. workflow config ID) held in Data Readiness resources

config
NotificationConfig · object
required

Schedule configuration (currently only NOTIFICATION is supported)

enabled
boolean
required

Whether the schedule is ready to be triggered

Response

Successful Response

Response body for a newly created schedule.

schedule_id
string
required

ID of the created schedule