White-label emails

Customize the emails we send to your customers on your behalf.

Customize the emails we send to your customers on your behalf: welcome emails, review alerts, connection invites, and the rest.

Every email type has a default template. Override the copy, turn types on or off, choose whether to show your logo, and decide whether we send the email or hand it to your system via webhook to send yourself. Preview and test before going live.

You'll need an account or partner token.

Prerequisites

  • A bearer token in the Authorization header. Any endpoint that needs no token says so on its own page.
  • The id of each record the call targets. Every endpoint page lists the ids it needs.

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
403The template type is platform-managed, or the email-template section is disabled for your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

List email types

POST — See every kind of email we can send and whether each is on.

Open →

Get an email template

POST — Get an email type's current template for editing.

Open →

List an email's merge fields

POST — See the merge fields available in an email type, such as the customer's name or the location.

Open →

Save an email template

POST — Save your custom version of an email type.

Open →

Preview an email

POST — Render an email type with sample data, without sending.

Open →

Send a test email

POST — Send an email type to an address you choose.

Open →

Turn an email type on or off

POST — Stop or resume sending a kind of email.

Open →

Choose who sends an email

POST — Choose whether we send an email type directly, or deliver its content to your webhook so your system sends it.

Open →

Show or hide your logo in emails

POST — Turn the logo on or off in an email type.

Open →

See email delivery history

POST — See recent emails of a type: recipient, time, and delivery status.

Open →

Reset an email to the default

POST — Discard your override and go back to the default template.

Open →


Did this page help you?