Sign in
Mailboxes

Create a mailbox API key

Changed on

Mints an additional bearer token plus IMAP/SMTP mailbox password for an existing mailbox. The plaintext key and password are shown exactly once — store them immediately.

Supply an Idempotency-Key header (any unique string, max 255 chars) to safely retry on network errors. Replays with the same key return the original response; replays with a different body return 409 idempotency_conflict.

post/mailboxes/{public_id}/keys

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailboxes/{public_id}/keys
  • 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.admin.manage)

Path parameters

public_idstring required

Mailbox public ID

Headers

Idempotency-Keystring

Client-chosen unique key to safely retry the request. Cached for 24h per (team, endpoint, key). Different body with same key returns 409 idempotency_conflict.

Example:mailbox-keys-create-20260424-001

Request body

app_namestring required

Human-friendly label for the new API key.

Response

Mailbox API key created. The response carries a Location header pointing at the canonical URL for the new key.

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "credential": {
      "imap_port": 993,
      "public_id": "smx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
      "server": "mail.sendmux.ai",
      "smtp_port": 587
    }
  }
}

Changes

  • b42ce87003aeRevision changes
    • breaking

      the // response's property type changed from no type to object for status

    • info

      removed subschema #2 from the // response property allOf list for the response status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

  • 7807ce923952Revision changes
    • info

      the endpoint scheme security oauth2 was added to the API