Skip to main content
PATCH
/
schedules
/
{function_name}
/
toggle
Toggle Schedule
curl --request PATCH \
  --url https://production.trackstarhq.com/schedules/{function_name}/toggle \
  --header 'Content-Type: application/json' \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>' \
  --data '{
  "paused": true
}'
{
  "id": "example-id-123",
  "object": "connection",
  "updated": true
}

Headers

​
x-trackstar-api-key
string
required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

​
x-trackstar-access-token
string
required

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

Example:

"<x-trackstar-access-token>"

Path Parameters

​
function_name
string
required

Body

application/json
​
paused
boolean
required

Whether the schedule is paused.

Example:

true

Response

Successful response

​
id
string
required

The id of the updated object.

Example:

"example-id-123"

​
object
string
required

The type of the object that was updated.

Example:

"connection"

​
updated
boolean
required

Whether or not the object was updated.

Example:

true