Skip to main content
POST
Add someone to a stay's roster

Authorizations

Authorization
string
header
required

Mobile token, global API token, series API key, or event API key. See Authentication above for which endpoints each one reaches.

Path Parameters

event_id
string
required

Event id or slug.

stay_id
string<uuid>
required

A stay id from GET /events/{event_id}/stays.

Body

application/json
email
string<email>

The buyer's email. Ignored when participant_event_id is sent.

participant_event_id
string<uuid>
eligibility_option_id
string<uuid>

One of the stay's eligibility option ids.

eligibility_option
string

An eligibility option's label, matched case-insensitively. Use this or eligibility_option_id.

Example:

"Bought it in the shop"

external_reference
string

Your own id for the purchase, e.g. an order number.

Example:

"order-1001"

notes
string

Response

Already on the roster; entry updated.

id
string<uuid>
stay_id
string<uuid>
participant_event_id
string<uuid>
eligibility_option
object | null
source
enum<string>
Available options:
manual,
csv,
group,
api
external_reference
string | null
notes
string | null
in_rooming_pool
boolean

False until the registration is complete or in progress and has an accommodation form, which rooming needs.

created_at
string<date-time>