Skip to content

Email a copy of an order's receipt​

POST
/event-orders/{id}/receipt/email

The buyer mails a copy of the order's receipt to any address, at most 5 per order. The buyer only (not a host, not staff): by account, the order's token, or buyer_code. The copy carries the receipt and a link to the event's page, never a ticket. An order whose US bank payment is still in progress sends the receipt that says so. Rate limited at 5 requests/minute per IP.

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​

Header Parameters

X-Order-Token

The order link's token, for a buyer without an account.

Type
string

Path Parameters

id*

The order's id.

Type
string
Required
Format
"uuid"

Query Parameters

token

The order link's token (or send it as X-Order-Token), for a buyer without an account. The buyer's first ticket code works too.

Type
string

Request Body​

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

Responses​

Sent, or queued and on its way.

application/json
JSON
{
"sent_to": "string",
"queued": true,
"receipt_email": "string"
}

Playground​

Server
Headers
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress