Create a calendar
Schedule module
POST/calendarscalendars.create
A working calendar with its time zone. Creates a calendar. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability schedule.timeline.write.
- OAuth scopes: schedule.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: CalendarCreate
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Calendar name.Constraints: length 1 to 300 |
| time_zone | string | Yes | IANA time zone the local time was entered in.Constraints: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$ |
| project_id | string (uuid) | null | No | Identifier of the project. |
{
"name": "Venue Working Days",
"time_zone": "America/New_York",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Response 201: Calendar
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the calendar. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| name | string | Yes | Calendar name.Constraints: length 1 to 300 |
| time_zone | string | Yes | IANA time zone the local time was entered in.Constraints: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$ |
| project_id | string (uuid) | null | Yes | Identifier of the project. |
{
"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",
"name": "Venue Working Days",
"time_zone": "America/New_York",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X POST "$XOS_BASE_URL/calendars" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"name":"Venue Working Days","time_zone":"America/New_York","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'const { data } = await xos.calendars.create({
"name": "Venue Working Days",
"time_zone": "America/New_York",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
});response = xos.calendars.create({"name": "Venue Working Days", "time_zone": "America/New_York", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})xos calendars create --data '{"name":"Venue Working Days","time_zone":"America/New_York","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'