POST
/
api
/
v1
/
schedules
/
{schedule_id}
/
activate
curl --request POST \
  --url https://api.trigger.dev/api/v1/schedules/{schedule_id}/activate \
  --header 'Authorization: Bearer <token>'
{
  "id": "sched_1234",
  "task": "my-scheduled-task",
  "active": true,
  "deduplicationKey": "dedup_key_1234",
  "externalId": "user_1234",
  "generator": {
    "type": "CRON",
    "expression": "0 0 * * *",
    "description": "Every day at midnight"
  },
  "nextRun": "2024-04-01T00:00:00Z",
  "environments": [
    {
      "id": "<string>",
      "type": "<string>",
      "userName": "<string>"
    }
  ]
}

Authorizations

Authorization
string
headerrequired

Use your Secret API key in the form 'Bearer <SECRET KEY>' (without the quotation marks)

Path Parameters

schedule_id
string
required

The ID of the schedule.

Response

200 - application/json
id
string

The unique ID of the schedule, prefixed with 'sched_'

task
string

The id of the scheduled task that will be triggered by this schedule

active
boolean

Whether the schedule is active or not

deduplicationKey
string

The deduplication key used to prevent creating duplicate schedules

externalId
string

The external ID of the schedule. Can be anything that is useful to you (e.g., user ID, org ID, etc.)

generator
object
nextRun
string

The next time the schedule will run

environments
object[]

Was this page helpful?

Deactivate ScheduleGitHub repo