Sign in

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 and address your app's mail is sent from.

Both fields are required, so send the current value for whichever you are not changing.

from_email picks which domain you are editing: its part after the @ has to be a domain already set up on this app, and you get a 404 when it is not. That means you cannot move to a different domain here, even though this looks like the endpoint that would. Use Replace the email domain for that.

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

<Note>This endpoint accepts a personal API key. Workspace API keys are not authorized for it and are rejected with a 403.</Note>

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.

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 picks which of the app's email domains you are editing and has to be one already set up.

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 does not change it.

Example response

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

Changes