Sign in
Mailbox API

Update mailbox sender identity

Changed on

Updates the default sender name, plain text signature, and HTML signature for the authenticated mailbox.

patch/mailbox/identity

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailbox/identity
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: mailbox.settings.update)

Query parameters

mailbox_idstring

Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.

Request body

html_signaturestring nullable

HTML signature appended to Mailbox API sends that include html_body.

namestring nullable

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

text_signaturestring nullable

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

Response

Updated mailbox sender identity

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "bcc": [
      {
        "email": "agent@example.com",
        "name": "Support"
      }
    ],
    "reply_to": [
      {
        "email": "agent@example.com",
        "name": "Support"
      }
    ]
  }
}

Changes