Skip to main content
PUT
Attach a receipt email

Path Parameters

id
string
required

The checkout to read — an order id or an invoice id. Base58 short id, 21–22 characters (never 0, O, I or l), e.g. 7Kq2mVn8pRt3XwYz5Bd4L — the value that appears in checkout and invoice links, and the one this API takes as a path id.

Pattern: ^[1-9A-HJ-NP-Za-km-z]{21,22}$
Example:

"7Kq2mVn8pRt3XwYz5Bd4L"

Body

application/json
email
string<email>
required

Where to send the receipt and any digital delivery. Recorded on the order and never echoed back — reads only report hasCustomerEmail.

Example:

"buyer@example.com"

Response

The email was recorded.

Acknowledgement that the buyer's receipt email was recorded.

hasCustomerEmail
boolean
required

True once an address is on file. The address itself is never echoed back.

Example:

true