Auth0 API

Emails

emails

Emails

Provider

emails.provider

Methods

Configure Email Provider ->
EmailProvider
post/emails/provider

Create an email provider. The credentials object requires different properties depending on the email provider (which is specified using the name property):

  • mandrill requires api_key
  • sendgrid requires api_key
  • sparkpost requires api_key. Optionally, set region to eu to use the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in North America. eu or null are the only valid values for region.
  • mailgun requires api_key and domain. Optionally, set region to eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or null are the only valid values for region.
  • ses requires accessKeyId, secretAccessKey, and region
  • smtp requires smtp_host, smtp_port, smtp_user, and smtp_pass
Depending on the type of provider it is possible to specify settings object with different configuration options, which will be used when sending an email:
  • smtp provider, settings may contain headers object.
    • When using AWS SES SMTP host, you may provide a name of configuration set in X-SES-Configuration-Set header. Value must be a string.
    • When using Sparkpost host, you may provide value for X-MSYS_API header. Value must be an object.
  • for ses provider, settings may contain message object, where you can provide a name of configuration set in configuration_set_name property. Value must be a string.
Get Email Provider ->
EmailProvider
get/emails/provider

Retrieve details of the email provider configuration in your tenant. A list of fields to include or exclude may also be specified.

Security

Example: Authorization: Bearer My Bearer Token

Parameters
fields: string
Optional

Comma-separated list of fields to include or exclude (dependent upon include_fields) from the result. Leave empty to retrieve name and enabled. Additional fields available include credentials, default_from_address, and settings.

include_fields: boolean
Optional

Whether specified fields are to be included (true) or excluded (false).

Response fields
EmailProvider
Request example
200Example
Update Email Provider ->
EmailProvider
patch/emails/provider

Update an email provider. The credentials object requires different properties depending on the email provider (which is specified using the name property):

  • mandrill requires api_key
  • sendgrid requires api_key
  • sparkpost requires api_key. Optionally, set region to eu to use the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in North America. eu or null are the only valid values for region.
  • mailgun requires api_key and domain. Optionally, set region to eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or null are the only valid values for region.
  • ses requires accessKeyId, secretAccessKey, and region
  • smtp requires smtp_host, smtp_port, smtp_user, and smtp_pass
Depending on the type of provider it is possible to specify settings object with different configuration options, which will be used when sending an email:
  • smtp provider, settings may contain headers object.
    • When using AWS SES SMTP host, you may provide a name of configuration set in X-SES-Configuration-Set header. Value must be a string.
    • When using Sparkpost host, you may provide value for X-MSYS_API header. Value must be an object.
    for ses provider, settings may contain message object, where you can provide a name of configuration set in configuration_set_name property. Value must be a string.

Domain types

EmailProvider = { getPayloadSchema }