RoadOpsDeveloper

Guest Requests

Ask

List guest requests

GET/v1/teams/{teamId}/days/{dayId}/events/{eventId}/guest-requests

Lists guest request records for an event.

Required scopes: guest_request:read

Parameters

path.teamIdrequiredstring:uuid

Team identifier.

path.dayIdrequiredstring:uuid

Day identifier.

path.eventIdrequiredstring:uuid

Event identifier.

query.limitinteger

Maximum number of records to return. Defaults to 50 and is capped at 200.

query.cursorstring

Cursor returned by page.nextCursor from the previous list response.

Response 200

dataobject[]
data[].dayIdstring:uuid

Day identifier that owns the event for this guest request.

data[].eventIdstring:uuid

Event identifier that owns this guest request.

data[].guestFirstNamestring

Guest's first name.

data[].guestLastNamestring

Guest's last name.

data[].totalTicketsinteger

Total 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[].attendeeContactEmailstring:email

Optional email address for the guest or attendee contact.

data[].notesstring

Internal notes for this guest request.

data[].ticketTypeobject

Optional ticket type snapshot requested for the guest.

data[].ticketType.ticketTypeIdstring:uuid

Ticket type identifier requested for this guest.

data[].ticketType.nameAtRequeststring

Ticket type display name captured when the guest request was created or updated.

data[].ticketType.abbreviationAtRequeststring

Short ticket type label captured when the guest request was created or updated.

data[].passesobject[]

Pass type requests associated with this guest request.

data[].passes[].passTypeIdstring:uuid

Pass type identifier requested for this guest.

data[].passes[].nameAtRequeststring

Pass type display name captured when the guest request was created or updated.

data[].passes[].abbreviationAtRequeststring

Short pass type label captured when the guest request was created or updated.

data[].passes[].quantityinteger

Number of passes requested for this pass type.

data[].assignedSeatsobject[]

Seat assignments attached after the guest request is fulfilled.

data[].assignedSeats[].idstring:uuid

Assigned seat identifier.

data[].assignedSeats[].sectionstring

Venue seating section label.

data[].assignedSeats[].rowstring

Venue seating row label.

data[].assignedSeats[].seatstring

Venue seating seat label.

data[].assignedSeats[].ticketTypeIdstring:uuid

Ticket type identifier associated with this assigned seat.

data[].idstring:uuid

Guest request identifier.

data[].orgIdstring:uuid

Team identifier that owns this guest request.

data[].isDeletedboolean

Whether the guest request has been deleted.

data[].createdBystring:uuid | string

User identifier that created the guest request.

data[].createdByNamestring

Display name captured for the creator.

data[].createdAtstring:date-time

ISO 8601 timestamp when the request was created.

data[].updatedAtstring:date-time

ISO 8601 timestamp when the request was last updated.

data[].versioninteger

Current guest request aggregate version.

data[].cursorinteger

Latest event-ledger cursor projected into this guest request record.

pageobject
page.limitinteger

Maximum number of records returned in this page.

page.nextCursorstring | null

Cursor to pass as the next request's cursor query parameter, or null when there are no more results.

metaobject
meta.cursornumber | null

Highest record cursor represented by this response.

Create a guest request

POST/v1/teams/{teamId}/days/{dayId}/events/{eventId}/guest-requests

Accepts a command to create a guest request for an event.

Required scopes: guest_request:write

Parameters

path.teamIdrequiredstring:uuid

Team identifier.

path.dayIdrequiredstring:uuid

Day identifier.

path.eventIdrequiredstring:uuid

Event identifier.

header.Idempotency-Keystring:uuid

Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Request body (application/json)

guestFirstNamerequiredstring

Guest's first name.

guestLastNamerequiredstring

Guest's last name.

totalTicketsrequiredinteger

Total 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.

attendeeContactEmailstring:email

Optional email address for the guest or attendee contact.

notesstring

Internal notes for this guest request.

assignedSeatsrequiredobject[]

Seat assignments attached after the guest request is fulfilled.

assignedSeats[].idrequiredstring:uuid

Assigned seat identifier.

assignedSeats[].sectionrequiredstring

Venue seating section label.

assignedSeats[].rowrequiredstring

Venue seating row label.

assignedSeats[].seatrequiredstring

Venue seating seat label.

assignedSeats[].ticketTypeIdstring:uuid

Ticket type identifier associated with this assigned seat.

idstring:uuid

Optional caller-supplied guest request ID. RoadOps generates one when omitted.

requestedByUserIdstring:uuid

Optional member ID to create the request on behalf of.

requestedByNamestring

Optional display name for the requested-by member.

ticketTypeobject

Optional ticket type requested for the guest.

ticketType.ticketTypeIdrequiredstring:uuid

Ticket type identifier requested for this guest.

passesrequiredobject[]

Pass type requests associated with this guest request.

passes[].passTypeIdrequiredstring:uuid

Pass type identifier requested for this guest.

passes[].quantityrequiredinteger

Number of passes requested for this pass type.

Response 202

commandIdstring:uuid

Command identifier accepted into the RoadOps command ledger.

resourceIdstring:uuid

Identifier of the resource targeted by the command.

resourceTypestring

Resource type targeted by the command.

status"applied"

Command dispatch status.

aggregateVersioninteger

Aggregate version produced by the accepted command.

cursorinteger

Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.

linksobject
links.refetchstring

Relative 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.teamIdrequiredstring:uuid

Team identifier.

path.dayIdrequiredstring:uuid

Day identifier.

path.eventIdrequiredstring:uuid

Event identifier.

path.guestRequestIdrequiredstring:uuid

Guest request identifier.

Response 200

dataobject
data.dayIdstring:uuid

Day identifier that owns the event for this guest request.

data.eventIdstring:uuid

Event identifier that owns this guest request.

data.guestFirstNamestring

Guest's first name.

data.guestLastNamestring

Guest's last name.

data.totalTicketsinteger

Total 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.attendeeContactEmailstring:email

Optional email address for the guest or attendee contact.

data.notesstring

Internal notes for this guest request.

data.ticketTypeobject

Optional ticket type snapshot requested for the guest.

data.ticketType.ticketTypeIdstring:uuid

Ticket type identifier requested for this guest.

data.ticketType.nameAtRequeststring

Ticket type display name captured when the guest request was created or updated.

data.ticketType.abbreviationAtRequeststring

Short ticket type label captured when the guest request was created or updated.

data.passesobject[]

Pass type requests associated with this guest request.

data.passes[].passTypeIdstring:uuid

Pass type identifier requested for this guest.

data.passes[].nameAtRequeststring

Pass type display name captured when the guest request was created or updated.

data.passes[].abbreviationAtRequeststring

Short pass type label captured when the guest request was created or updated.

data.passes[].quantityinteger

Number of passes requested for this pass type.

data.assignedSeatsobject[]

Seat assignments attached after the guest request is fulfilled.

data.assignedSeats[].idstring:uuid

Assigned seat identifier.

data.assignedSeats[].sectionstring

Venue seating section label.

data.assignedSeats[].rowstring

Venue seating row label.

data.assignedSeats[].seatstring

Venue seating seat label.

data.assignedSeats[].ticketTypeIdstring:uuid

Ticket type identifier associated with this assigned seat.

data.idstring:uuid

Guest request identifier.

data.orgIdstring:uuid

Team identifier that owns this guest request.

data.isDeletedboolean

Whether the guest request has been deleted.

data.createdBystring:uuid | string

User identifier that created the guest request.

data.createdByNamestring

Display name captured for the creator.

data.createdAtstring:date-time

ISO 8601 timestamp when the request was created.

data.updatedAtstring:date-time

ISO 8601 timestamp when the request was last updated.

data.versioninteger

Current guest request aggregate version.

data.cursorinteger

Latest event-ledger cursor projected into this guest request record.

metaobject
meta.cursorinteger

Highest 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.teamIdrequiredstring:uuid

Team identifier.

path.dayIdrequiredstring:uuid

Day identifier.

path.eventIdrequiredstring:uuid

Event identifier.

path.guestRequestIdrequiredstring:uuid

Guest request identifier.

header.Idempotency-Keystring:uuid

Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Request body (application/json)

expectedVersioninteger

Optional aggregate version guard.

updatesrequiredobject
updates.guestFirstNamestring

Updated guest first name.

updates.guestLastNamestring

Updated guest last name.

updates.totalTicketsinteger

Updated requested ticket count.

updates.pickupLocation"will_call" | "in_hand" | "other"

Updated pickup location.

updates.attendeeContactEmailstring:email | null

Updated attendee email, or null to clear it.

updates.notesstring | null

Updated request notes, or null to clear them.

updates.ticketTypeobject | null

Updated ticket type, or null to clear it.

updates.ticketType.ticketTypeIdstring:uuid

Ticket type identifier requested for this guest.

updates.passesobject[]

Updated pass requests.

updates.passes[].passTypeIdrequiredstring:uuid

Pass type identifier requested for this guest.

updates.passes[].quantityrequiredinteger

Number of passes requested for this pass type.

Response 202

commandIdstring:uuid

Command identifier accepted into the RoadOps command ledger.

resourceIdstring:uuid

Identifier of the resource targeted by the command.

resourceTypestring

Resource type targeted by the command.

status"applied"

Command dispatch status.

aggregateVersioninteger

Aggregate version produced by the accepted command.

cursorinteger

Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.

linksobject
links.refetchstring

Relative 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.teamIdrequiredstring:uuid

Team identifier.

path.dayIdrequiredstring:uuid

Day identifier.

path.eventIdrequiredstring:uuid

Event identifier.

path.guestRequestIdrequiredstring:uuid

Guest request identifier.

header.Idempotency-Keystring:uuid

Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Response 202

commandIdstring:uuid

Command identifier accepted into the RoadOps command ledger.

resourceIdstring:uuid

Identifier of the resource targeted by the command.

resourceTypestring

Resource type targeted by the command.

status"applied"

Command dispatch status.

aggregateVersioninteger

Aggregate version produced by the accepted command.

cursorinteger

Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.

linksobject
links.refetchstring

Relative URL to refetch the affected resource.