POST
/
schedules
/
{scheduled_run_uid}
/
{action}
Update the status of a scheduled run
curl --request POST \
  --url https://api.captaindata.com/v4/schedules/{scheduled_run_uid}/{action} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{}'
{
  "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "action_id": 123,
  "action_name": "<string>",
  "user_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "ACTIVE",
  "postponed_until": "2023-11-07T05:31:56Z",
  "cron": "<string>",
  "timezone": "<string>",
  "next_execution_at": "2023-11-07T05:31:56Z",
  "last_executed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
scheduled_run_uid
string<uuid>
required

Scheduled run UUID

​
action
enum<string>
required

With this action, you can resume, cancel or pause the scheduled run.

Available options:
resume,
cancel,
pause

Body

application/json · object

Response

200
application/json

Returns the scheduled runs