Create a schedule

Body: { setup_id, frequency (daily|weekly|every_two_weeks|monthly), timezone (IANA), local_time (HH:MM), start_date (YYYY-MM-DD) }. Creating a schedule authorizes recurring paid work, so the wallet must be activated with auto-reload enabled and authorized (402 otherwise), and the setup must be an accessible, non-archived setup (404 otherwise). The stored grid is the local settings; responses always carry the next occurrence in UTC (DST-anchored: a missing local time runs at the next valid local time, a doubled local time runs once, and a monthly schedule set for a missing day runs on that month’s final day). One ACTIVE schedule per setup: a second active schedule answers 409. An invalid grid answers 400.

POST/schedules

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.

Header parameters

Idempotency-Keystringrequired

A new value, such as a UUID, for each new request. Send the same value to retry a request safely; see https://docs.zaraftis.com/conventions#safe-retries-with-idempotency-key.

min length 1 · max length 64

Request body

requiredapplication/json

setup_idstring<uuid>required

matches ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

frequencystringrequired

Allowed:dailyweeklyevery_two_weeksmonthly

timezonestringrequired

min length 1 · max length 64

local_timestringrequired

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

start_datestringrequired

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

Responses

201

The created schedule with its UTC next occurrence

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

409

conflict, duplicate_url, or idempotency_conflict

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 POST 'https://api.zaraftis.com/v1/schedules' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Idempotency-Key: string' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "setup_id": "223e7533-659b-4438-b6f4-f841a5d7dfa9",
  "frequency": "daily",
  "timezone": "string",
  "local_time": "string",
  "start_date": "string"
}'

const response = await fetch("https://api.zaraftis.com/v1/schedules", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Idempotency-Key": "string",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"setup_id\": \"223e7533-659b-4438-b6f4-f841a5d7dfa9\",\n  \"frequency\": \"daily\",\n  \"timezone\": \"string\",\n  \"local_time\": \"string\",\n  \"start_date\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://api.zaraftis.com/v1/schedules",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Idempotency-Key": "string",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"setup_id\": \"223e7533-659b-4438-b6f4-f841a5d7dfa9\",\n  \"frequency\": \"daily\",\n  \"timezone\": \"string\",\n  \"local_time\": \"string\",\n  \"start_date\": \"string\"\n}",
)

Response

The created schedule with its UTC next occurrence

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

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