Choose who sends an email

Choose whether we send an email type directly, or deliver its content to your webhook so your system sends it. webhook needs a type that supports it (supports_webhook in List email types) and an active webhook subscription.

Prerequisites: a bearer token, the account's id (company_id) and the email type from List email types.

Authentication: Partner or Account token. company_id must be inside your own account tree (a Partner token reaches any account under the partner, an Account token only its own); otherwise 422. The account's partner must have the email templates section turned on; otherwise 403. Types managed centrally by the platform return 403.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
Defaults to 5994

The account. Must exist and be inside your account tree.

string
enum
required
Defaults to user_welcome

The email type, from List email types.

string
enum
required
Defaults to webhook

direct (we send it) or webhook (we send its content to your webhook). webhook fails validation when the type doesn't support webhook delivery, or when the account has no active webhook subscription.

Allowed:
integer
Defaults to 18

The webhook subscription to deliver to, when delivery_method is webhook. Must be active and belong to your partner. Left out: any active subscription must exist.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json