Create a schedule actual
Schedule module
POST/schedule-actualsscheduleActuals.create
Actual start and finish of a record. Creates a schedule actual. 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: ScheduleActualCreate
| Field | Type | Required | Description |
|---|---|---|---|
| record_id | string (uuid) | Yes | Identifier of the record. |
| actual_start_at | string (date-time) | null | No | Actual start. |
| actual_end_at | string (date-time) | null | No | Actual finish. |
{
"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"actual_start_at": "2026-10-08T14:30:00Z",
"actual_end_at": "2026-10-08T14:30:00Z"
}Response 201: ScheduleActual
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the schedule actual. |
| 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. |
| record_id | string (uuid) | Yes | Identifier of the record. |
| actual_start_at | string (date-time) | null | Yes | Actual start. |
| actual_end_at | string (date-time) | null | Yes | Actual finish. |
{
"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",
"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"actual_start_at": "2026-10-08T14:30:00Z",
"actual_end_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X POST "$XOS_BASE_URL/schedule-actuals" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","actual_start_at":"2026-10-08T14:30:00Z","actual_end_at":"2026-10-08T14:30:00Z"}'const { data } = await xos.scheduleActuals.create({
"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"actual_start_at": "2026-10-08T14:30:00Z",
"actual_end_at": "2026-10-08T14:30:00Z"
});response = xos.schedule_actuals.create({"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "actual_start_at": "2026-10-08T14:30:00Z", "actual_end_at": "2026-10-08T14:30:00Z"})xos schedule-actuals create --data '{"record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","actual_start_at":"2026-10-08T14:30:00Z","actual_end_at":"2026-10-08T14:30:00Z"}'