Create a guest list entry
Advancing module
POST/guest-list-entriesguestListEntries.create
A guest on a project's guest list with plus-ones. Requested guests are approved or declined by someone with review authority who did not request them, then checked in at the door. Creates a guest list entry. 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 advancing.rider.write.
- OAuth scopes: advancing.
- 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: GuestListEntryCreate
| Field | Type | Required | Description |
|---|---|---|---|
| project_id | string (uuid) | Yes | Identifier of the project. |
| scope_node_id | string (uuid) | null | No | Identifier of the show or other scope node of the same project. |
| guest_name | string | Yes | Name the guest gives at the door.Constraints: length 1 to 200 |
| plus_ones | integer | Yes | Additional guests admitted with this guest, 0 to 20.Constraints: range 0 to any |
| note | string | null | No | Notes for the door.Constraints: length 1 to 500 |
{
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"guest_name": "Jordan Pike",
"plus_ones": 1,
"note": "Side stage."
}Response 201: GuestListEntry
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the guest list entry. |
| 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. |
| 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. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| scope_node_id | string (uuid) | null | Yes | Identifier of the show or other scope node of the same project. |
| person_id | string (uuid) | null | Yes | Identifier of the person whose list the guest is on. |
| counterparty_id | string (uuid) | null | Yes | Identifier of the organization whose list the guest is on. |
| engagement_id | string (uuid) | null | Yes | Identifier of the engagement the guest was requested under in Gateway. |
| guest_name | string | Yes | Name the guest gives at the door.Constraints: length 1 to 200 |
| plus_ones | integer | Yes | Additional guests admitted with this guest, 0 to 20.Constraints: range 0 to any |
| note | string | null | Yes | Notes for the door.Constraints: length 1 to 500 |
| entry_state | "Requested" | "Approved" | "Declined" | "Checked In" | Yes | Requested, Approved, Declined or Checked In; moved by the decide and check-in actions. |
| decided_at | string (date-time) | null | Yes | When the request was approved or declined. Set by the database. |
| decided_by | string (uuid) | null | Yes | Identifier of the person who decided, set by the database. |
| checked_in_at | string (date-time) | null | Yes | When the guest was checked in. Set by the database. |
| checked_in_by | string (uuid) | null | Yes | Identifier of the person who checked the guest in, set by the database. |
{
"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",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"guest_name": "Jordan Pike",
"plus_ones": 1,
"note": "Side stage.",
"entry_state": "Requested",
"decided_at": "2026-10-08T14:30:00Z",
"decided_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"checked_in_at": "2026-10-08T14:30:00Z",
"checked_in_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X POST "$XOS_BASE_URL/guest-list-entries" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","scope_node_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","guest_name":"Jordan Pike","plus_ones":1,"note":"Side stage."}'const { data } = await xos.guestListEntries.create({
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"guest_name": "Jordan Pike",
"plus_ones": 1,
"note": "Side stage."
});response = xos.guest_list_entries.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "guest_name": "Jordan Pike", "plus_ones": 1, "note": "Side stage."})xos guest-list-entries create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","scope_node_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","guest_name":"Jordan Pike","plus_ones":1,"note":"Side stage."}'