Skip to main content
PATCH
/
domains
/
{public_id}
Update a mailbox domain
curl --request PATCH \
  --url https://app.sendmux.ai/api/v1/domains/{public_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "send_receive"
}
'
{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "ok": true,
  "data": {
    "created_at": "<string>",
    "dns_records": {
      "dkim": [
        {
          "name": "_sendmux.acme.com",
          "value": "sendmux-verify=team_abc123"
        }
      ],
      "dmarc": {
        "name": "_sendmux.acme.com",
        "value": "sendmux-verify=team_abc123"
      },
      "mx": [
        {
          "priority": 10,
          "target": "mail.sendmux.ai"
        }
      ],
      "spf": {
        "name": "_sendmux.acme.com",
        "value": "sendmux-verify=team_abc123"
      },
      "verification": {
        "name": "_sendmux.acme.com",
        "value": "sendmux-verify=team_abc123"
      }
    },
    "domain": "mail.acme.com",
    "id": "mdom_clxxxxxxxxxxxxxxxxxxxxxxxxx",
    "mailbox_count": 14,
    "mode": "send_receive",
    "ses_dkim_status": "<string>",
    "verified_at": "<string>"
  }
}

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.

Headers

​
If-Match
string

Weak ETag from a prior GET. Reject with 409 conflict when the server's current ETag differs.

Path Parameters

​
public_id
string
required

Domain public ID

Example:

"mdom_clxxxxxxxxxxxxxxxxxxxxxxxxx"

Body

application/json
​
mode
enum<string>
required

The only supported update is upgrading to send_receive.

Available options:
send_receive
Example:

"send_receive"

Response

Updated domain

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