Skip to main content
PATCH
/
mailbox
/
identity
Update mailbox sender identity
curl --request PATCH \
  --url https://app.sendmux.ai/api/v1/mailbox/identity \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "text_signature": "<string>",
  "html_signature": "<string>"
}
'
{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "id": "<string>",
    "name": "<string>",
    "email": "jsmith@example.com",
    "reply_to": [
      {
        "email": "agent@example.com",
        "name": "Support"
      }
    ],
    "bcc": [
      {
        "email": "agent@example.com",
        "name": "Support"
      }
    ],
    "text_signature": "<string>",
    "html_signature": "<string>",
    "may_delete": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.sendmux.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Body

application/json
​
name
string | null

Default sender name. Send null or an empty string to clear it.

Maximum string length: 254
​
text_signature
string | null

Plain text signature appended to Mailbox API sends that include text_body.

Maximum string length: 2047
​
html_signature
string | null

HTML signature appended to Mailbox API sends that include html_body.

Maximum string length: 2047

Response

Updated mailbox sender identity

​
ok
enum<boolean>
required
Available options:
true
​
meta
object
required
​
data
object
required