Skip to main content
POST
/
api
/
v1
/
waiting-areas
/
{waiting_area}
/
invite
Error
A valid request URL is required to generate request examples

Authorizations

​
Authorization
string
header
required

Provide a Bearer Token

Body

application/json
​
type
enum<string>
required

The type of invite to send

Available options:
email,
sms
Example:

"email"

​
email
string | null

The email address to send the invite to. Required if type is email.

Example:

"[email protected]"

​
phone_number
string | null

The phone number to send the invite to. Required if type is sms.

Example:

123456789

​
invite_message
string | null

The message to send with the invite. Will automatically include the link to the waiting area. Use {{waiting_area_name}} and {{link}} to include the name of the waiting area and the link to the waiting area respectively.

Example:

"Join {{waiting_area_name}} at {{link}}"

Response

204

The request has succeeded.