Participation Object

The participation object represents the relationship between a participant and an event or schedule. It includes details about the participant, whether the participation status is confirmed or pending, which app owns the relevant event or schedule, and allows for custom data extensions.

Properties
idstringRead-onlyformat GUID

Participation ID.

externalIdstringformat GUID

External ID.

participantParticipant

Information about the participant.

partySizeintegerminimum 1maximum 1000format int32

Party size of the group or 1 for individuals.

Min: 1 Max: 1000

statusstring

Status of the party's participation in the event. Depending on your implementation, confirmation may be handled by the business owner or the customer.

Supported values:

  • CONFIRMED: The party's participation is confirmed. For example, the business owner has confirmed a booking.
  • PENDING_CONFIRMATION: The party's participation is awaiting confirmation. For example, the business owner still needs to approve the booking.

Default: CONFIRMED

appIdstringRead-onlyformat GUID

ID of the app that owns the participation object. Identical to appId of the schedule that the related event belongs to.

revisionintegerRead-onlyformat int64

Revision number, which increments by 1 each time the participation is updated. To prevent conflicting changes, the current revision must be passed when updating the participation. Ignored when creating a participation.

createdDatestringRead-onlyformat date-time

Date the participation was created in YYYY-MM-DDThh:mm:ss.sssZ format.

updatedDatestringRead-onlyformat date-time

Date the participation was updated in YYYY-MM-DDThh:mm:ss.sssZ format.

extendedFieldsExtendedFields

Extensions enabling applications or users to save custom data related to the participation.

ONE OF:
scheduleIdstringformat GUID

ID of the schedule associated with the participation.

eventIdstringminLength 36maxLength 250

ID of the event associated with the participation.

Did this help?