Skip to content

Events · VIP guests​

VIP guests (#2709): complimentary seats inside the event's capacity, out of the hosts' reserve (vip_reserved_seats) first, then out of public seats if any remain. The hosts send a ticket at once or invite the guest to confirm, by email or by a personal short link (https://fundlyhub.org/i/<code>, 10 characters without 0 O 1 l I) they send themselves; a phone number is never sent to the server. The guest answers by the link alone: rate limited, Referrer-Policy: no-referrer, never cached or indexed, and GET changes nothing. Behind features.events.


VIP guests​

GET
/events/{id}/guest-invites

Every VIP guest of the event, newest first, and where the reserve stands. Hosts and staff (as Add 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​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"

Responses​

The invites and the reserve.

application/json
JSON
{
"invites": [
],
"vip": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


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​


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​


Revoke a VIP guest​

DELETE
/events/{id}/guest-invites/{inviteId}

Status revoked: the link stops working, a going guest's order is cancelled (free) and the seats go back. Refused once part of the party checked in.

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​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
inviteId*
Type
string
Required
Format
"uuid"

Responses​

Revoked.

application/json
JSON
{
"invite": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Change a VIP guest's seats or date to answer by​

PATCH
/events/{id}/guest-invites/{inviteId}

A pending invite's hold follows its seats (more must fit). A going guest's party is lowered with them, cancelling the highest seats nobody checked in (never below those who did, 409 events.invites.reasons.below_checked_in); a ticket the host sent follows them up too, while an invited guest may raise their own party up to the new number.

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​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
inviteId*
Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"seats": 0,
"respond_by": "string",
"name": "string"
}

Responses​

Changed.

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

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


A new link​

POST
/events/{id}/guest-invites/{inviteId}/new-link

A new link code; the old link stops working (404 invite_not_found).

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)

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
inviteId*
Type
string
Required
Format
"uuid"

The invite with its new link.

application/json
JSON
{
"invite": "string"
}
Server
Authorization
Variables
Key
Value

Add an email​

POST
/events/{id}/guest-invites/{inviteId}/email

Saves the address and sends what the invite's state calls for (the invitation while pending, the ticket while going).

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​

Path Parameters

id*

The event's id.

Type
string
Required
Format
"uuid"
inviteId*
Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"email": "string"
}

Responses​

Saved.

application/json
JSON
{
"invite": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​


A VIP guest's invitation, by their link​

GET
/guest-invites/{code}

The event, the invitation, the ticket once going, and the personalized link preview (Open Graph) in the invite's language. Changes nothing. An unknown, replaced or revoked code is 404 invite_not_found; a revoked one's carries details.host_name, whom to ask for a new link.

Authorizations​

or
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​

Path Parameters

code*

The link's code (10 characters without 0 O 1 l I).

Type
string
Required
Pattern
"^[2-9a-km-zA-HJ-NP-Z]{10}$"

Query Parameters

lang

The preview's language (else the invite's).

Type
string
Valid values
"en""ru""uk""es"

Responses​

The invitation.

application/json
JSON
"string"

Playground​

Server
Variables
Key
Value

Samples​


Confirm N seats​

POST
/guest-invites/{code}/confirm

Makes the complimentary order for party_size (1 to the seats given); the seats not taken go back to the reserve; the ticket is emailed when there is an address. Again with the same size: the same ticket; another size changes the party. After a decline: while the time to answer lasts and the seats are there.

Authorizations​

or
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​

Path Parameters

code*

The link's code (10 characters without 0 O 1 l I).

Type
string
Required
Pattern
"^[2-9a-km-zA-HJ-NP-Z]{10}$"

Request Body​

application/json
JSON
{
"party_size": 0
}

Responses​

The ticket.

application/json
JSON
{
"ticket": "string"
}

Playground​

Server
Variables
Key
Value
Body

Samples​


Can't make it​

POST
/guest-invites/{code}/decline

While pending (a going guest releases instead); the seats go back. keep_posted is "Keep me posted about future events".

Authorizations​

or
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​

Path Parameters

code*

The link's code (10 characters without 0 O 1 l I).

Type
string
Required
Pattern
"^[2-9a-km-zA-HJ-NP-Z]{10}$"

Request Body​

application/json
JSON
{
"keep_posted": true
}

Responses​

Declined.

application/json
JSON
{
"ok": true
}

Playground​

Server
Variables
Key
Value
Body

Samples​


Change guests​

POST
/guest-invites/{code}/party

A going guest lowers their party, or raises it back up to the seats given when capacity allows; never below the seats already checked in.

Authorizations​

or
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​

Path Parameters

code*

The link's code (10 characters without 0 O 1 l I).

Type
string
Required
Pattern
"^[2-9a-km-zA-HJ-NP-Z]{10}$"

Request Body​

application/json
JSON
{
"party_size": 0
}

Responses​

The ticket.

application/json
JSON
{
"ticket": "string"
}

Playground​

Server
Variables
Key
Value
Body

Samples​


Release my seats​

POST
/guest-invites/{code}/release

A going guest gives every seat back; the order is cancelled and the invite released. Refused once part of the party checked in.

Authorizations​

or
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​

Path Parameters

code*

The link's code (10 characters without 0 O 1 l I).

Type
string
Required
Pattern
"^[2-9a-km-zA-HJ-NP-Z]{10}$"

Responses​

Released.

application/json
JSON
{
"ok": true
}

Playground​

Server
Variables
Key
Value

Samples​


Get updates by email​

POST
/guest-invites/{code}/email

Only while no email is on file (409 events.invites.reasons.email_on_file); a going guest's ticket is sent there.

Authorizations​

or
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​

Path Parameters

code*

The link's code (10 characters without 0 O 1 l I).

Type
string
Required
Pattern
"^[2-9a-km-zA-HJ-NP-Z]{10}$"

Request Body​

application/json
JSON
{
"email": "string"
}

Responses​

Saved.

application/json
JSON
{
"ok": true
}

Playground​

Server
Variables
Key
Value
Body

Samples​


Powered by VitePress OpenAPI

Built with VitePress