Skip to main content
POST
Send Email

Send Email

Sends one transactional email on the merchant’s behalf. The platform picks the transport: the merchant’s own SMTP when they have configured one, otherwise the platform sender. Your app never sees the merchant’s mail credentials. Requires the send_emails scope. Use it for the emails your app owns — ready-for-pickup, return approved, shipment delivered — not for marketing.

Request

Body

string
required
One recipient address. Send one request per recipient — never a shared To.
string
required
Subject line.
string
required
The HTML body. Inline your styles; there is no template wrapper applied.
string
Reply-To address (for example the merchant’s support inbox). Defaults to the store’s business email, so shopper replies reach the merchant. An invalid address is rejected with 400.
The email is sent from the store’s name: through the merchant’s own SMTP sender when configured, otherwise from the platform address with the store name as the sender name.

Response

transport is merchant_smtp when the merchant’s own SMTP was used and platform otherwise; suggest merchants configure their own sender for best deliverability.

Errors