Delete a schedule

Destructive. A DELETE without the body { confirm: true } answers 400 confirmation_required with the consequences and the re-send form. With confirm the schedule record is removed, all future scheduled scans stop, and the setup stays usable for manual scans (historical scans keep their own records and billing).

DELETE/schedules/{schedule_id}

Authorization

AuthorizationBearer token · headerrequired

API key sent as Authorization: Bearer <key>. A key belongs to one workspace, has scopes, and can be limited to some brands.

AuthorizationOAuth2 access token · headerrequired

OAuth 2.1 sign-in (authorization code with PKCE) used by AI assistants that connect through the Zaraftis MCP server. Discovery URLs are at https://api.zaraftis.com/api/auth.

Path parameters

schedule_idstring<uuid>required

Request body

requiredapplication/json

confirmbooleanrequired

Responses

200

The removed schedule reference

ScheduleDeletedEnvelope

400

bad_request or validation_failed

successbooleanrequired

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsobject

field_errorsobject[]

Show properties

Array of object

fieldstringrequired

codestringrequired

Allowed:requiredformattoo_smalltoo_largeunrecognized_keyinvalid

messagestringrequired

request_idRequestIdrequired

404

not_found: unknown id, or an id this key cannot see

successbooleanrequired

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsobject

field_errorsobject[]

Show properties

Array of object

fieldstringrequired

codestringrequired

Allowed:requiredformattoo_smalltoo_largeunrecognized_keyinvalid

messagestringrequired

request_idRequestIdrequired

Request

curl -X DELETE 'https://api.zaraftis.com/v1/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "confirm": true
}'

const response = await fetch("https://api.zaraftis.com/v1/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"confirm\": true\n}"
});

import requests

response = requests.delete(
    "https://api.zaraftis.com/v1/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"confirm\": true\n}",
)

Response

The removed schedule reference

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": {},
    "field_errors": [
      {
        "field": "string",
        "code": "required",
        "message": "string"
      }
    ]
  },
  "request_id": "string"
}

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": {},
    "field_errors": [
      {
        "field": "string",
        "code": "required",
        "message": "string"
      }
    ]
  },
  "request_id": "string"
}