POST
/
api
/
v1
/
schedules
/
{schedule_id}
/
deactivate
import { schedules } from "@trigger.dev/sdk/v3";

const schedule = await schedules.deactivate(scheduleId);
{
  "id": "sched_1234",
  "task": "my-scheduled-task",
  "type": "IMPERATIVE",
  "active": true,
  "deduplicationKey": "dedup_key_1234",
  "externalId": "user_1234",
  "generator": {
    "type": "CRON",
    "expression": "0 0 * * *",
    "description": "Every day at midnight"
  },
  "timezone": "America/New_York",
  "nextRun": "2024-04-01T00:00:00Z",
  "environments": [
    {
      "id": "<string>",
      "type": "<string>",
      "userName": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use your project-specific Secret API key. Will start with tr_dev_, tr_prod, tr_stg, etc.

You can find your Secret API key in the API Keys section of your Trigger.dev project dashboard.

Our TypeScript SDK will default to using the value of the TRIGGER_SECRET_KEY environment variable if it is set. If you are using the SDK in a different environment, you can set the key using the configure function.

import { configure } from "@trigger.dev/sdk/v3";

configure({ accessToken: "tr_dev_1234" });

Path Parameters

​
schedule_id
string
required

The ID of the schedule.

Response

200
application/json
Schedule updated successfully
​
id
string

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

Example:

"sched_1234"

​
task
string

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

Example:

"my-scheduled-task"

​
type
string

The type of schedule, DECLARATIVE or IMPERATIVE. Declarative schedules are declared in your code by setting the cron property on a schedules.task. Imperative schedules are created in the dashboard or by using the imperative SDK functions like schedules.create().

Example:

"IMPERATIVE"

​
active
boolean

Whether the schedule is active or not

Example:

true

​
deduplicationKey
string

The deduplication key used to prevent creating duplicate schedules

Example:

"dedup_key_1234"

​
externalId
string

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

Example:

"user_1234"

​
generator
object
​
timezone
string

Defaults to UTC. In IANA format, if set then it will trigger at the CRON frequency in that timezone and respect daylight savings time.

Example:

"America/New_York"

​
nextRun
string

The next time the schedule will run

Example:

"2024-04-01T00:00:00Z"

​
environments
object[]

Was this page helpful?

Suggest editsRaise issue