Create a new schedule

Create a recurring schedule (cron job) to send messages at specified intervals

POST/api/v2/schedules

Authorization

AuthorizationBearer token (Anlyon API key) · headerrequired

Workspace API key sent as Authorization: Bearer <key>.

better-auth.session_tokenAPI key · cookierequired

Browser session used by dashboard-only operations.

Header parameters

X-Request-Idstring

Optional caller correlation ID. Unsafe or oversized values are replaced.

max length 128

Request body

requiredapplication/json

namestringrequired

Human-readable name for the schedule

min length 1 · max length 100

cronExpressionstringrequired

Cron expression defining the schedule

timezonestring

Timezone for the cron schedule

default: "UTC"

urlstring<uri>required

Destination URL

methodstring

default: "POST"

Allowed:GETPOSTPUTPATCHDELETE

headersobject

bodyany

Request body

Responses

200

Schedule created successfully

successboolean

dataPublicSchedule

Show properties

scheduleIdstringrequired

matches ^sch_

namestringrequired

cronExpressionstringrequired

timezonestring | nullrequired

urlstring<uri>required

methodstringrequired

Allowed:GETPOSTPUTPATCHDELETE

headersobject | nullrequired

Delivery headers with sensitive values redacted.

bodyany | nullrequired

Request body

isActivebooleanrequired

isPausedbooleanrequired

nextRunAtstring<date-time> | nullrequired

lastRunAtstring<date-time> | nullrequired

lastStatusstring | nullrequired

createdAtstring<date-time>required

updatedAtstring<date-time>required

400

Bad Request - Invalid input data

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

401

Unauthorized - Invalid or missing API key

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

402

Payment Required - Feature not available on current plan

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

403

Authenticated credential lacks the required scope or workspace access.

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

429

Too Many Requests - either the request rate limit, or the plan's cap on how many of this resource may exist. The code distinguishes them: RATE_LIMIT_EXCEEDED clears on its own, QUOTA_EXCEEDED does not until you remove one or upgrade.

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (Anlyon API key)Remember on this deviceInclude my values in samples

Parameters

X-Request-IdheaderOptional caller correlation ID. Unsafe or oversized values are replaced.

Bodyapplication/json

Request body

Request

curl -X POST 'https://api.anlyon.com/api/v2/schedules' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Daily Report",
  "cronExpression": "0 9 * * *",
  "timezone": "America/New_York",
  "url": "https://example.com/webhook",
  "method": "POST",
  "body": {
    "type": "daily_report"
  }
}'

const response = await fetch("https://api.anlyon.com/api/v2/schedules", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"Daily Report\",\n  \"cronExpression\": \"0 9 * * *\",\n  \"timezone\": \"America/New_York\",\n  \"url\": \"https://example.com/webhook\",\n  \"method\": \"POST\",\n  \"body\": {\n    \"type\": \"daily_report\"\n  }\n}"
});

import requests

response = requests.post(
    "https://api.anlyon.com/api/v2/schedules",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"Daily Report\",\n  \"cronExpression\": \"0 9 * * *\",\n  \"timezone\": \"America/New_York\",\n  \"url\": \"https://example.com/webhook\",\n  \"method\": \"POST\",\n  \"body\": {\n    \"type\": \"daily_report\"\n  }\n}",
)

Response

{
  "success": true,
  "data": {
    "scheduleId": "sch_1234567890abcdef",
    "name": "Daily Report",
    "cronExpression": "0 9 * * *",
    "timezone": "UTC",
    "url": "https://example.com/webhook",
    "method": "POST",
    "headers": {},
    "body": {
      "report": "daily"
    },
    "isActive": true,
    "isPaused": false,
    "nextRunAt": "2026-07-14T09:00:00Z",
    "lastRunAt": null,
    "lastStatus": null,
    "createdAt": "2026-07-13T12:00:00Z",
    "updatedAt": "2026-07-13T12:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {
      "url": "Invalid URL format"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "Invalid or missing API key"
  }
}

{
  "success": false,
  "error": {
    "code": "FEATURE_NOT_AVAILABLE",
    "message": "Schedules are not available on your current plan. Upgrade to Pay as You Go or Enterprise."
  }
}

{
  "success": false,
  "requestId": "req_0123456789abcdef0123456789abcdef",
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "QUOTA_EXCEEDED",
    "message": "Free plan allows up to 10 active schedules. You have 10. Upgrade to Pay as You Go for unlimited schedules."
  }
}