Skip to main content
PATCH
Update email sender details

Authorizations

api_key
string
header
required

Personal API key.

Path Parameters

app_id
string
required

ID of the app whose email domains you want to work with.

Body

application/json

Request to update email domain configuration.

sender_name
string
required

Name recipients see in the From line. Required, so resend the current value to keep it.

Example:

"Nordwind Furniture"

from_email
string<email>
required

Address mail is sent from. Its domain has to be one the app already has set up for email. Required, so resend the current value to keep it.

Example:

"hello@example.com"

Response

The updated sender details.

Response for updating email domain configuration.

sender_name
string
required

The name now in use.

Example:

"Nordwind Furniture"

from_email
string
required

The address now in use, lower-cased.

Example:

"hello@example.com"

domain
string
required

The domain this configuration belongs to.

Example:

"example.com"

configuration_status
string
required

Where setup stands. Updating these fields doesn't change it. Only active sends mail. The pending_ values mean setup is still in progress, and the failed_ values mean it stopped and you can start it again with Retry email domain setup.

Example:

"active"