Email management

The Mail API enables you to send email according to a specified template.

Setup

To set the sender of the email to an email address of your domain (for exmple, noreply@mybrand.com), your domain must be verified at the OneWelcome Identity Platform AWS.

1. Request to verify your domain via support@onewelcome.com.
2. Add a TXT record to your domain's DNS server with the Name and Value provided by the OneWelcome Identity Platform.
   • If your DNS provider does not allow underscores in record names, you can omit "_amazonses" from the Name.
   • To help you easily identify this record within your domain's DNS settings, you can optionally prefix the Value with "amazonses: ".
   • Some DNS providers automatically append the domain name to DNS record names. To avoid duplication of the domain name, you can add a period to the end of the domain name in the DNS record. This indicates that the record name is fully qualified and the DNS provider need not append an additional domain name.

Templates

The relationship-invitation template

Emails constructed with this template will be formed as follows:

Hello {name},

You've been invited to join {application}.
To accept this invitation, click on this **link**, or navigate to this URL in your browser:
{actionUrl}

Thank you

Configuration of the Mail API: Config API

Access token authorization

Requests sent to the Mail API must be accompanied by an access token issued by a trusted authorization server. To validate the token, the issuer and its JWKS endpoint must be known to the OneWelcome Identity Platform. Optionally, the tenant can define an audience, which must be specified in the access token.

To view or update the configuration for the Relationship Management API, use the following endpoints:

• Get authorization config
• Update authorization config