v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB

Emails::Address

Update Email Address

Update a sender address — most commonly to change its name (the from-name). You may also move it to a different verified domain via emails_domain_id.

put/emails/addresses/{id}

Path parameters

idstring required

Request body

Example request

{
  "emails_address": {
    "emails_address": {
      "username": "hello",
      "name": "Acme Support"
    }
  }
}

Response

idinteger

Address ID

public_idstring nullable

Address public ID

workspace_idinteger

Workspace ID

email_addressstring

Email address

namestring nullable

Display name associated with this email address

is_workspace_defaultboolean

Whether this is the workspace's default email address

usable_as_senderboolean

Whether this address is eligible to be used as the from sender of an email broadcast. True when it is on a verified sending domain (verified ownership + DNS), has a custom SMTP setting, or — when the workspace has no verified sender of its own — is on the shared sending domain. Filter broadcast senders to addresses where this is true to avoid a broadcast failing validation at send time.

created_atstring date-time nullable

Created at datetime

updated_atstring date-time nullable

Updated at datetime

Example response

{
  "id": 1,
  "public_id": "AbCdEf",
  "workspace_id": 42000,
  "email_address": "marketing@example.com",
  "name": "Marketing Team",
  "is_workspace_default": false,
  "usable_as_sender": true,
  "emails_domain": {
    "name": "example.com",
    "verified": true,
    "dkim_verified": true,
    "spf_verified": true,
    "dmarc_verified": true,
    "smtp_verified": false
  },
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}