TRtrackstarhq
Schedules

Toggle All Schedules

Pause or unpause every schedule for the connection associated with your access token in a single call.

patch/schedules/toggle-all

Request

  • Base URL
    https://production.trackstarhq.com
  • URL
    https://production.trackstarhq.com/schedules/toggle-all
  • Auth
    none 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
}

Changes

No recorded changes to this operation across all 4 revisions of this API.