Skip to main content
PUT
/
v1
/
models
/
{modelId}
/
suggestions
/
schedule
curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "timezone": "America/New_York"
}
'
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "sharedModelId": "f1e2d3c4-b5a6-7890-abcd-ef9876543210",
  "status": "enabled",
  "timezone": "America/New_York"
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
modelId
string<uuid>
required

The unique identifier of the model.

Body

application/json
​
timezone
string

IANA timezone string (e.g., America/New_York, Europe/London, UTC). Determines when the daily suggestion generation runs. Defaults to UTC if not provided.

Response

Schedule enabled successfully. Returns the current state of the schedule, or the same state if already enabled.

​
id
string<uuid>
required

Unique identifier for the schedule.

​
sharedModelId
string<uuid>
required

The shared model the schedule generates suggestions for.

​
status
enum<string>
required
Available options:
enabled
​
timezone
string
required

IANA timezone the schedule runs in.

Example:

"America/New_York"