Add guests to a visit

Add one or more guests to an existing visit. Returns the newly created guest invites.

Returns 409 Conflict if any of the provided email addresses are already invited to the visit.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Visit ID (UUID)

Body Params
guests
array of objects
required
length ≥ 1

Guests to add to the visit

guests*
string
required

Name of the guest

string
required

Email address of the guest

custom_fields
array of objects

Custom field values for this guest

custom_fields
boolean
Defaults to true

Whether to send email invites to guests. Defaults to true.

Responses

400

Validation error — missing or invalid parameters

401

Authentication required — no valid user identity

404

Visit not found

409

Conflict — one or more guests are already invited to this visit

500

Internal server error

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json