Turn an email type on or off

Stop or resume sending a kind of email. Use this if you handle a notification yourself, or don't want it sent.

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.

boolean
required
Defaults to false

true to send this type, false to stop sending it.

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