Sign in

v1

latestOpenAPI 3.1.02026-07-22802,2441.7 MB
Schedules

Toggle Schedule

Pause or unpause a schedule for the connection associated with your access token.

patch/schedules/{function_name}/toggle

Path parameters

function_namestring required

Headers

x-trackstar-api-keystring required
Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

x-trackstar-access-tokenstring required
Example:<x-trackstar-access-token>

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Request body

pausedboolean required

Whether the schedule is paused.

Example request

{
  "paused": true
}

Response

Successful response

idstring required

The id of the updated object.

objectstring required

The type of the object that was updated.

updatedboolean required

Whether or not the object was updated.

Example response

{
  "id": "example-id-123",
  "object": "connection",
  "updated": true
}