Guest Object

Properties

idstringformat GUID

Guest ID.

eventIdstringformat GUID

Event ID.

rsvpIdstringformat GUID

RSVP ID.

Note: Only applicable when guestType is RSVP.

orderNumberstring

Order number.

Note: Only applicable when guestType is BUYER or TICKET_HOLDER.

ticketNumberstring

Ticket number.

Note: Only applicable when guestType is TICKET_HOLDER.

ticketsArray <TicketDetails>

List of names, numbers, and definition IDs for each ticket.

contactIdstring

Guest's contact ID. See Contacts API for more details.

guestDetailsobject

Guest details.

Returned only when the guestDetails fieldset is sent in the request.

attendanceStatusstring

3 enum supported values:

NOT_ATTENDINGATTENDINGIN_WAITLIST

Attendance status.

Note: For guestType BUYER or TICKET_HOLDER the IN_WAITLIST value is not applicable.

secondaryLanguageCodestringformat LANGUAGE

Secondary language code in ISO 639-1 format. Used when the event ticket should be translated into another language.

createdDatestringformat date-time

Date and time the guest was created in yyyy-mm-ddThh:mm:sssZ format.

updatedDatestringformat date-time

Date and time the guest was updated in yyyy-mm-ddThh:mm:sssZ format.

attendanceStatusUpdatedDatestringformat date-time

Date and time of guest's latest attendance status update.

memberIdstringformat GUID

Site member ID.

guestTypestring

3 enum supported values:

RSVPBUYERTICKET_HOLDER

Guest type:

RSVP: An invited guest, no ticket necessary.

BUYER: The guest who bought the tickets.

TICKET_HOLDER: The guest for whom the ticket was bought.

localestringformat LANGUAGE_TAG

Locale in IETF BCP 47 format. Used when the event date and time on a ticket should be formatted into another locale.

totalGuestsintegerRead-onlyformat int32

Number of current guest plus additional guests

revisionintegerRead-onlyformat int64

Guest revision

Was this helpful?

Yes