Create a record checklist item
Work module
POST/record-checklist-itemsrecordChecklistItems.create
One checklist item of a record. Items are rows, never array positions. Creates a record checklist item. 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 work.punch_list.write.
- OAuth scopes: work.
- 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: RecordChecklistItemCreate
| Field | Type | Required | Description |
|---|---|---|---|
| record_id | string (uuid) | Yes | Identifier of the record. |
| position | integer | Yes | Display position.Constraints: range 1 to any |
| label | string | Yes | Item label.Constraints: length 1 to 300 |
| done | boolean | Yes | Whether the item is done. |
| evidence_document_id | string (uuid) | null | No | Identifier of the photo or document evidence. |
{
"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"position": 1,
"label": "Check the safety cables",
"done": false,
"evidence_document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Response 201: RecordChecklistItem
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the record checklist item. |
| 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. |
| position | integer | Yes | Display position.Constraints: range 1 to any |
| label | string | Yes | Item label.Constraints: length 1 to 300 |
| done | boolean | Yes | Whether the item is done. |
| done_by | string (uuid) | null | Yes | Identifier of the person who ticked the item. |
| done_at | string (date-time) | null | Yes | When the item was ticked. |
| evidence_document_id | string (uuid) | null | Yes | Identifier of the photo or document evidence. |
{
"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",
"position": 1,
"label": "Check the safety cables",
"done": false,
"done_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"done_at": "2026-10-08T14:30:00Z",
"evidence_document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X POST "$XOS_BASE_URL/record-checklist-items" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","position":1,"label":"Check the safety cables","done":false,"evidence_document_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'const { data } = await xos.recordChecklistItems.create({
"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"position": 1,
"label": "Check the safety cables",
"done": false,
"evidence_document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
});response = xos.record_checklist_items.create({"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "position": 1, "label": "Check the safety cables", "done": False, "evidence_document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})xos record-checklist-items create --data '{"record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","position":1,"label":"Check the safety cables","done":false,"evidence_document_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'