Delete a Schedule

Remove a schedule and its run history.

POST /jobs_schedule_delete

Removes a schedule and its run history. The list it filled, and every job and contact already in it, is not touched.

There is no undo. To stop a schedule for a while instead, pause it with Update or Pause a Schedule (is_active: false).

Free. credits_used is always 0.

Headers

Name	Value
Content-Type	application/json

Body

Name	Type	Description
api_key	string	Required. Your API key.
schedule_id	integer	Required. From List Schedules.

An id that is not one of yours returns 404 and nothing is deleted.

Example

Input

{
  "api_key": "your_api_key",
  "schedule_id": 62
}

Output

{
  "status": "success",
  "credits_used": 0.0,
  "credits_remaining": 6012.5,
  "data": {
    "schedule_id": 62,
    "deleted": true
  }
}