Load Schedule Template

Apply a saved template to a target week, creating new shifts from the template's stored shifts.

Endpoint

POST /v1/staff/schedule/templates/{id}/load

Authentication

Requires an API key with the staff:write scope.

Path Parameters

Parameter	Type	Description
id	integer	Template ID

Request Body

Parameter	Type	Required	Description
target_week_start	string	Yes	Monday of the week to load the template into (YYYY-MM-DD)
overwrite	boolean	No	Delete existing shifts in the target week before loading (default: false)

Response

Success (200 OK)

{
  "data": {
    "created_count": 10,
    "skipped_count": 0
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-04-01T09:00:00+00:00"
  }
}

Errors

Status	Code	Description
401	authentication_required	No API key provided
401	invalid_api_key	Invalid API key
403	insufficient_scope	API key lacks staff:write scope
404	template_not_found	Template not found or belongs to another supplier
422	validation_error	Missing or invalid fields

Example Request

curl -X POST "https://app.equipdash.com/api/v1/staff/schedule/templates/3/load" \
  -H "Authorization: Bearer eqd_live_abc123xyz789..." \
  -H "Content-Type: application/json" \
  -d '{
    "target_week_start": "2026-04-20",
    "overwrite": false
  }'