Update a schedule

Body (any subset): frequency, timezone, local_time, start_date (edits keep the calendar-anchored local clock), status (active|paused). Re-enabling (paused → active) re-checks the auto-reload rule first (402 otherwise).

PATCH/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

frequencystring

Allowed:dailyweeklyevery_two_weeksmonthly

timezonestring

min length 1 · max length 64

local_timestring

matches ^([01][0-9]|2[0-3]):[0-5][0-9]$

start_datestring

matches ^\d{4}-\d{2}-\d{2}$

statusstring

Allowed:activepaused

Responses

200

The schedule after the update

ScheduleEnvelope

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

402

wallet_not_activated, insufficient_credits, or payment_action_required

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 PATCH '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 '{
  "frequency": "daily",
  "timezone": "string",
  "local_time": "string",
  "start_date": "string",
  "status": "active"
}'

const response = await fetch("https://api.zaraftis.com/v1/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"frequency\": \"daily\",\n  \"timezone\": \"string\",\n  \"local_time\": \"string\",\n  \"start_date\": \"string\",\n  \"status\": \"active\"\n}"
});

import requests

response = requests.patch(
    "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  \"frequency\": \"daily\",\n  \"timezone\": \"string\",\n  \"local_time\": \"string\",\n  \"start_date\": \"string\",\n  \"status\": \"active\"\n}",
)

Response

The schedule after the update

{
  "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"
}

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