EvoHub Docs Sign in

On-Call API › Schedule layers

Update a layer

Use with AI
View as MarkdownThis page as plain text, for pasting into an AI tool Open in ClaudeAsk Claude questions about this page Open in ChatGPTAsk ChatGPT questions about this page
Connect to Cursor / VS Code / ClaudeSearch and read these docs from your AI tool (MCP server)

MCP server URL

https://docs-dev.evohub.io/mcp

Add to CursorAdd to VS Code

Claude Code

claude mcp add --transport http evohub-docs-docs https://docs-dev.evohub.io/mcp

Claude (claude.ai and Claude Desktop): Settings → Connectors → Add custom connector, and paste the URL above.

Claude Desktop — claude_desktop_config.json

{
  "mcpServers": {
    "evohub-docs-docs": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://docs-dev.evohub.io/mcp"
      ]
    }
  }
}

Cursor — ~/.cursor/mcp.json

{
  "mcpServers": {
    "evohub-docs-docs": {
      "url": "https://docs-dev.evohub.io/mcp"
    }
  }
}

VS Code — .vscode/mcp.json

{
  "servers": {
    "evohub-docs-docs": {
      "type": "http",
      "url": "https://docs-dev.evohub.io/mcp"
    }
  }
}

llms.txtllms-full.txt

PATCH/api/v1/schedules/{id}/layers/{layerID}

Changes a layer. name, priority, rotation_type, rotation_start and handoff_time keep their value when left out or empty. handoff_day keeps its value when left out and is written when sent, 0 included. The restrict_* fields change only when sent; send empty strings for both times (and an empty weekday list) to turn a shift back into an all-day layer.

Permission (API-key scope): oncall:schedule:write.

Authorization

Any one of:

Parameters

Path parameters

  • id string required
    The schedule's id.
    Example: 5b1c7d2e-8f3a-4b9c-a0d1-e2f3a4b5c6d7
  • layerID string required
    The layer's id. It must belong to the schedule in the path.
    Example: 7c3d9e1f-2a4b-4c6d-8e0f-1a2b3c4d5e6f

Request body required

Content type: application/json

Type: ScheduleLayerWrite

On create name and rotation_type are required.

  • name string
  • priority integer
  • rotation_type RotationType
    One of: daily weekly custom
  • rotation_start string (date-time)
    Defaults to now on create.
  • handoff_day integer
    Minimum: 0 · Maximum: 6
  • handoff_time string
    HH:MM
    Example: 09:00
  • restrict_to_weekdays array of integer
    0 is Sunday.
  • restrict_start_time string
    HH:MM; give the end too. Empty clears the window.
  • restrict_end_time string
    HH:MM; may be earlier than the start for a shift across midnight.

Responses

200

The layer after the change.

Content type: application/json

Type: object

  • data ScheduleLayer required
    Show ScheduleLayer properties
    • id string
    • schedule_id string
    • name string
    • priority integer
      Layers with a higher priority win over lower ones.
    • rotation_type RotationType
      One of: daily weekly custom
    • rotation_start string (date-time)
      When the rota's first turn started.
    • handoff_day integer
      Weekday of the handover for weekly rotas, 0 (Sunday) to 6.
    • handoff_time string
      HH:MM of the handover.
    • restrict_to_weekdays array of integer
    • restrict_start_time string
      HH:MM
    • restrict_end_time string
      HH:MM
    • rotations array of ScheduleRotation
      Show ScheduleRotation properties
      • id string
      • layer_id string
      • user_id string
      • position integer
        0-based place in the rota.
      • created_at string (date-time)
    • created_at string (date-time)
    • updated_at string (date-time)
  • success boolean required
    Value: true

400

The body is not JSON (INVALID_BODY), or a weekday or the shift window is invalid (VALIDATION_FAILED).

Content type: application/json

Type: ValidationError

  • error object required
    • code string required
      Value: VALIDATION_FAILED
    • message string required
    • details array of object required
      • field string
      • message string

401

No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.

403

The key lacks the scope this endpoint needs (FORBIDDEN).

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.

404

No such schedule, or no such layer on it (NOT_FOUND).

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.

429

Too many requests (RATE_LIMITED). Wait Retry-After seconds.

Headers

  • Retry-After integer
    Seconds to wait.

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.

500

Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.

Example request

curl -X PATCH 'https://evohub.io/api/v1/schedules/5b1c7d2e-8f3a-4b9c-a0d1-e2f3a4b5c6d7/layers/7c3d9e1f-2a4b-4c6d-8e0f-1a2b3c4d5e6f' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <TOKEN>' \
  -d '{
  "handoff_day": 1,
  "restrict_end_time": "",
  "restrict_start_time": "",
  "restrict_to_weekdays": []
}'

Last updated