Skip to content

Add a VIP guest​

POST
/events/{id}/guest-invites

Complimentary seats (1-20) for a member (profile_id) or a name. delivery: ticket confirms at once and issues the order; invite holds the seats until the guest confirms or declines, or until respond_by (else the event's start). The email goes when send_email is not false and there is an address (email, else the member's account email); a guest with neither gets the link only. uses_public_seats: how many of the seats came out of public sale because the reserve was used up. 409 not_allowed (events.orders.reasons.not_enough_seats, details.left) when they do not fit. Honours Idempotency-Key. Audited.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Header Parameters

Idempotency-Key

Optional (#2709): 16 to 200 of [A-Za-z0-9_.:-], a uuid. Kept two days, scoped to the endpoint, the event and the caller.

Type
string
Pattern
"^[A-Za-z0-9_.:-]{16,200}$"

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"kind": "string",
"delivery": "string",
"name": "string",
"email": "string",
"profile_id": "string",
"seats": 0,
"ticket_type_id": "string",
"respond_by": "string",
"send_email": true,
"event_day_id": "string",
"language": "string"
}

Responses​

Added.

application/json
JSON
{
"invite": "string",
"uses_public_seats": 0
}

Playground​

Server
Authorization
Headers
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress