Domains

Update a mailbox domain

Changed on

Upgrades a send-only domain to sending and receiving. Downgrades are rejected. After upgrade, the domain returns to pending until the required MX record verifies.

patch/domains/{public_id}

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/domains/{public_id}
  • 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: domain.create)

Path parameters

public_idstring required

Domain public ID

Example:mdom_clxxxxxxxxxxxxxxxxxxxxxxxxx

Headers

If-Matchstring

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

Request body

mode'send_receive' required

The only supported update is upgrading to send_receive.

Example request

{
  "mode": "send_receive"
}

Response

Updated domain

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "dns_records": {
      "dkim": [
        {
          "name": "_sendmux.acme.com",
          "value": "sendmux-verify=team_abc123"
        }
      ],
      "dmarc": {
        "name": "_sendmux.acme.com",
        "value": "sendmux-verify=team_abc123"
      },
      "mail_from": {
        "mx": {
          "name": "bounce.acme.com",
          "priority": 10,
          "target": "feedback-smtp.eu-central-1.amazonses.com"
        },
        "spf": {
          "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"
  }
}

Changes

  • 7807ce923952Revision changes
    • info

      the endpoint scheme security oauth2 was added to the API

  • a53e49562216Revision changes
    • 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