Skip to content

Add many VIP guests​

POST
/events/{id}/guest-invites/bulk

Up to 200 VIP guests at once (#2716) with the settings of one VIP add: each row is added in order by the single add, in its own transaction, never all or nothing; a row that does not fit or is invalid is reported and the rest are still added. A row with an email (a member's is their account's) is emailed unless send_email is false; every invite carries its link, which the hosts send to those without an email. uses_public_seats: the batch's seats that came out of public sale. A refusal about the settings (respond_by_past, unknown_ticket_type, ...) stops the batch as in Add many people. With Idempotency-Key each row is kept under <key>:bulk:<index>: a retried batch adds nobody twice. Rate limited per account: ten batches in ten minutes, with Add many people.

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
{
"rows": [
],
"kind": "string",
"delivery": "string",
"seats": 0,
"ticket_type_id": "string",
"respond_by": "string",
"send_email": true,
"event_day_id": "string",
"language": "string"
}

Responses​

Each row's result, in order.

application/json
JSON
{
"results": [
{
"index": 0,
"ok": true,
"invite": "string",
"uses_public_seats": 0
}
],
"added": 0,
"failed": 0,
"uses_public_seats": 0
}

Playground​

Server
Authorization
Headers
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress