Skip to content

Publish a day sheet

Show module

POST/day-sheets/{id}/publishdaySheets.publish

Publishes the day sheet to its audience. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability show.call_sheet.publish.
  • OAuth scopes: show.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

daySheets.publish: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the day sheet.

Response 200: DaySheet

daySheets.publish: DaySheet
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the day sheet.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
daystring (date)YesDay the sheet covers; one sheet per project and day.
bodystringYesDay sheet content as rich text.Constraints: length 1 to 20000
project_idstring (uuid)YesIdentifier of the project of the day sheet.
published_atstring (date-time) | nullYesWhen the day sheet was published, stamped by the database; set once by the publish action.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "day": "2026-10-08",
  "body": "Doors at 18:00. Load-out after the encore.",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "published_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X POST "$XOS_BASE_URL/day-sheets/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/publish" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
const { data } = await xos.daySheets.publish("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.day_sheets.publish("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos day-sheets publish 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f