Update email sender details

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Changes the name or address your app's mail is sent from.

The domain part of from_email has to be a domain this app already has set up for email. The call edits that domain's sender details and nothing else, so it never changes which domain your mail goes out from. Use Replace the email domain for that.

The change applies at once and doesn't re-run verification, so a domain that was active keeps sending.

patch/api/apps/{app_id}/custom-email-domains

Path parameters

app_idstring required

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

Request body

sender_namestring required

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

from_emailstring 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 request

{
  "sender_name": "Nordwind Furniture",
  "from_email": "hello@example.com"
}

Response

The updated sender details.

sender_namestring required

The name now in use.

from_emailstring required

The address now in use, lower-cased.

domainstring required

The domain this configuration belongs to.

configuration_statusstring 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 response

{
  "sender_name": "Nordwind Furniture",
  "from_email": "hello@example.com",
  "domain": "example.com",
  "configuration_status": "active"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.