Guest Requests
Ask
List guest requests
GET/v1/teams/{teamId}/days/{dayId}/events/{eventId}/guest-requestsLists guest request records for an event.
Required scopes: guest_request:read
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
path.eventIdrequired | string:uuidEvent identifier. |
query.limit | integerMaximum number of records to return. Defaults to 50 and is capped at 200. |
query.cursor | stringCursor returned by page.nextCursor from the previous list response. |
Response 200
data | object[] |
|---|---|
data[].dayId | string:uuidDay identifier that owns the event for this guest request. |
data[].eventId | string:uuidEvent identifier that owns this guest request. |
data[].guestFirstName | stringGuest's first name. |
data[].guestLastName | stringGuest's last name. |
data[].totalTickets | integerTotal number of tickets requested for the guest. |
data[].status | "pending" | "approved" | "denied"Current approval status for the guest request. |
data[].pickupLocation | "will_call" | "in_hand" | "other"Where the guest should receive or pick up their tickets. |
data[].attendeeContactEmail | string:emailOptional email address for the guest or attendee contact. |
data[].notes | stringInternal notes for this guest request. |
data[].ticketType | objectOptional ticket type snapshot requested for the guest. |
data[].ticketType.ticketTypeId | string:uuidTicket type identifier requested for this guest. |
data[].ticketType.nameAtRequest | stringTicket type display name captured when the guest request was created or updated. |
data[].ticketType.abbreviationAtRequest | stringShort ticket type label captured when the guest request was created or updated. |
data[].passes | object[]Pass type requests associated with this guest request. |
data[].passes[].passTypeId | string:uuidPass type identifier requested for this guest. |
data[].passes[].nameAtRequest | stringPass type display name captured when the guest request was created or updated. |
data[].passes[].abbreviationAtRequest | stringShort pass type label captured when the guest request was created or updated. |
data[].passes[].quantity | integerNumber of passes requested for this pass type. |
data[].assignedSeats | object[]Seat assignments attached after the guest request is fulfilled. |
data[].assignedSeats[].id | string:uuidAssigned seat identifier. |
data[].assignedSeats[].section | stringVenue seating section label. |
data[].assignedSeats[].row | stringVenue seating row label. |
data[].assignedSeats[].seat | stringVenue seating seat label. |
data[].assignedSeats[].ticketTypeId | string:uuidTicket type identifier associated with this assigned seat. |
data[].id | string:uuidGuest request identifier. |
data[].orgId | string:uuidTeam identifier that owns this guest request. |
data[].isDeleted | booleanWhether the guest request has been deleted. |
data[].createdBy | string:uuid | stringUser identifier that created the guest request. |
data[].createdByName | stringDisplay name captured for the creator. |
data[].createdAt | string:date-timeISO 8601 timestamp when the request was created. |
data[].updatedAt | string:date-timeISO 8601 timestamp when the request was last updated. |
data[].version | integerCurrent guest request aggregate version. |
data[].cursor | integerLatest event-ledger cursor projected into this guest request record. |
page | object |
page.limit | integerMaximum number of records returned in this page. |
page.nextCursor | string | nullCursor to pass as the next request's cursor query parameter, or null when there are no more results. |
meta | object |
meta.cursor | number | nullHighest record cursor represented by this response. |
Create a guest request
POST/v1/teams/{teamId}/days/{dayId}/events/{eventId}/guest-requestsAccepts a command to create a guest request for an event.
Required scopes: guest_request:write
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
path.eventIdrequired | string:uuidEvent identifier. |
header.Idempotency-Key | string:uuidOptional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request. |
Request body (application/json)
guestFirstNamerequired | stringGuest's first name. |
|---|---|
guestLastNamerequired | stringGuest's last name. |
totalTicketsrequired | integerTotal number of tickets requested for the guest. |
statusrequired | "pending" | "approved" | "denied"Current approval status for the guest request. |
pickupLocationrequired | "will_call" | "in_hand" | "other"Where the guest should receive or pick up their tickets. |
attendeeContactEmail | string:emailOptional email address for the guest or attendee contact. |
notes | stringInternal notes for this guest request. |
assignedSeatsrequired | object[]Seat assignments attached after the guest request is fulfilled. |
assignedSeats[].idrequired | string:uuidAssigned seat identifier. |
assignedSeats[].sectionrequired | stringVenue seating section label. |
assignedSeats[].rowrequired | stringVenue seating row label. |
assignedSeats[].seatrequired | stringVenue seating seat label. |
assignedSeats[].ticketTypeId | string:uuidTicket type identifier associated with this assigned seat. |
id | string:uuidOptional caller-supplied guest request ID. RoadOps generates one when omitted. |
requestedByUserId | string:uuidOptional member ID to create the request on behalf of. |
requestedByName | stringOptional display name for the requested-by member. |
ticketType | objectOptional ticket type requested for the guest. |
ticketType.ticketTypeIdrequired | string:uuidTicket type identifier requested for this guest. |
passesrequired | object[]Pass type requests associated with this guest request. |
passes[].passTypeIdrequired | string:uuidPass type identifier requested for this guest. |
passes[].quantityrequired | integerNumber of passes requested for this pass type. |
Response 202
commandId | string:uuidCommand identifier accepted into the RoadOps command ledger. |
|---|---|
resourceId | string:uuidIdentifier of the resource targeted by the command. |
resourceType | stringResource type targeted by the command. |
status | "applied"Command dispatch status. |
aggregateVersion | integerAggregate version produced by the accepted command. |
cursor | integerEvent-ledger cursor for the accepted update. Refetch until returned records reach this cursor. |
links | object |
links.refetch | stringRelative URL to refetch the affected resource. |
Retrieve a guest request
GET/v1/teams/{teamId}/days/{dayId}/events/{eventId}/guest-requests/{guestRequestId}Returns one guest request record by ID.
Required scopes: guest_request:read
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
path.eventIdrequired | string:uuidEvent identifier. |
path.guestRequestIdrequired | string:uuidGuest request identifier. |
Response 200
data | object |
|---|---|
data.dayId | string:uuidDay identifier that owns the event for this guest request. |
data.eventId | string:uuidEvent identifier that owns this guest request. |
data.guestFirstName | stringGuest's first name. |
data.guestLastName | stringGuest's last name. |
data.totalTickets | integerTotal number of tickets requested for the guest. |
data.status | "pending" | "approved" | "denied"Current approval status for the guest request. |
data.pickupLocation | "will_call" | "in_hand" | "other"Where the guest should receive or pick up their tickets. |
data.attendeeContactEmail | string:emailOptional email address for the guest or attendee contact. |
data.notes | stringInternal notes for this guest request. |
data.ticketType | objectOptional ticket type snapshot requested for the guest. |
data.ticketType.ticketTypeId | string:uuidTicket type identifier requested for this guest. |
data.ticketType.nameAtRequest | stringTicket type display name captured when the guest request was created or updated. |
data.ticketType.abbreviationAtRequest | stringShort ticket type label captured when the guest request was created or updated. |
data.passes | object[]Pass type requests associated with this guest request. |
data.passes[].passTypeId | string:uuidPass type identifier requested for this guest. |
data.passes[].nameAtRequest | stringPass type display name captured when the guest request was created or updated. |
data.passes[].abbreviationAtRequest | stringShort pass type label captured when the guest request was created or updated. |
data.passes[].quantity | integerNumber of passes requested for this pass type. |
data.assignedSeats | object[]Seat assignments attached after the guest request is fulfilled. |
data.assignedSeats[].id | string:uuidAssigned seat identifier. |
data.assignedSeats[].section | stringVenue seating section label. |
data.assignedSeats[].row | stringVenue seating row label. |
data.assignedSeats[].seat | stringVenue seating seat label. |
data.assignedSeats[].ticketTypeId | string:uuidTicket type identifier associated with this assigned seat. |
data.id | string:uuidGuest request identifier. |
data.orgId | string:uuidTeam identifier that owns this guest request. |
data.isDeleted | booleanWhether the guest request has been deleted. |
data.createdBy | string:uuid | stringUser identifier that created the guest request. |
data.createdByName | stringDisplay name captured for the creator. |
data.createdAt | string:date-timeISO 8601 timestamp when the request was created. |
data.updatedAt | string:date-timeISO 8601 timestamp when the request was last updated. |
data.version | integerCurrent guest request aggregate version. |
data.cursor | integerLatest event-ledger cursor projected into this guest request record. |
meta | object |
meta.cursor | integerHighest record cursor represented by this response. |
Update a guest request
PATCH/v1/teams/{teamId}/days/{dayId}/events/{eventId}/guest-requests/{guestRequestId}Accepts a command to update guest request fields.
Required scopes: guest_request:write
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
path.eventIdrequired | string:uuidEvent identifier. |
path.guestRequestIdrequired | string:uuidGuest request identifier. |
header.Idempotency-Key | string:uuidOptional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request. |
Request body (application/json)
expectedVersion | integerOptional aggregate version guard. |
|---|---|
updatesrequired | object |
updates.guestFirstName | stringUpdated guest first name. |
updates.guestLastName | stringUpdated guest last name. |
updates.totalTickets | integerUpdated requested ticket count. |
updates.pickupLocation | "will_call" | "in_hand" | "other"Updated pickup location. |
updates.attendeeContactEmail | string:email | nullUpdated attendee email, or null to clear it. |
updates.notes | string | nullUpdated request notes, or null to clear them. |
updates.ticketType | object | nullUpdated ticket type, or null to clear it. |
updates.ticketType.ticketTypeId | string:uuidTicket type identifier requested for this guest. |
updates.passes | object[]Updated pass requests. |
updates.passes[].passTypeIdrequired | string:uuidPass type identifier requested for this guest. |
updates.passes[].quantityrequired | integerNumber of passes requested for this pass type. |
Response 202
commandId | string:uuidCommand identifier accepted into the RoadOps command ledger. |
|---|---|
resourceId | string:uuidIdentifier of the resource targeted by the command. |
resourceType | stringResource type targeted by the command. |
status | "applied"Command dispatch status. |
aggregateVersion | integerAggregate version produced by the accepted command. |
cursor | integerEvent-ledger cursor for the accepted update. Refetch until returned records reach this cursor. |
links | object |
links.refetch | stringRelative URL to refetch the affected resource. |
Delete a guest request
DELETE/v1/teams/{teamId}/days/{dayId}/events/{eventId}/guest-requests/{guestRequestId}Accepts a command to delete a guest request.
Required scopes: guest_request:write
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
path.eventIdrequired | string:uuidEvent identifier. |
path.guestRequestIdrequired | string:uuidGuest request identifier. |
header.Idempotency-Key | string:uuidOptional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request. |
Response 202
commandId | string:uuidCommand identifier accepted into the RoadOps command ledger. |
|---|---|
resourceId | string:uuidIdentifier of the resource targeted by the command. |
resourceType | stringResource type targeted by the command. |
status | "applied"Command dispatch status. |
aggregateVersion | integerAggregate version produced by the accepted command. |
cursor | integerEvent-ledger cursor for the accepted update. Refetch until returned records reach this cursor. |
links | object |
links.refetch | stringRelative URL to refetch the affected resource. |