Update a sender address

Update a sender address

PATCH/api/v1/email/senders/{id}

PATCH /email/senders/{id}
curl -X PATCH 'https://www.unitpost.com/api/v1/email/senders/sndr_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "display_name": "Acme Support"
  }'
Response · 200
{
  "object": "sender",
  "id": "id_123",
  "domain_id": "domain_123",
  "address": "string",
  "display_name": "string",
  "from": "you@yourdomain.com",
  "source": "manual",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Change a sender's display name, the only field that changes: a different mailbox is a new sender. Requires the domains:write capability.

Parameters1 field
FieldTypeDescription
idrequiredstring · path—
Request body1 field
FieldTypeDescription
display_namerequiredstring | nullThe new display name; `null` or `""` clears it.
Response · 200 fields9 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
domain_idrequiredstring—
addressrequiredstring`local_part@domain`.
display_namerequiredstring | null—
fromrequiredstringThe From value to send with: `Display Name <address>`, or the address alone.
sourcerequiredenummanual | api`manual` (saved by someone) or `api` (seen on a send through the API).
created_atrequiredstring—
updated_atrequiredstring—
200400401403404422

Search docs and guides

Search the docs and product guides.