Skip to main content
POST
/
module
/
instance
/
schedule
/
{instance_id}
Create/Update Schedule
curl --request POST \
  --url https://api.getoutbox.ai/module/instance/schedule/{instance_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-User-Timezone: <x-user-timezone>' \
  --data '
{
  "schedule": {
    "minute": "0",
    "hour": "0",
    "day_of_week": "*",
    "day_of_month": "*"
  }
}
'

Authorizations

​
Authorization
string
header
required

Company API Key

Headers

​
X-User-Timezone
string
required

User's timezone for schedule

Path Parameters

​
instance_id
string
required

The ID of the module instance

Body

application/json

Schedule details in crontab format

​
schedule
object
required

Response

Schedule created/updated successfully