Sign in
Mailbox API

Get mailbox sender identity

Changed on

Returns the default sender identity and signatures for the authenticated mailbox.

get/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.read)

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.

Response

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