Sending accounts

Update a sending account

Updates a custom sending account or replaces variables on the shared Amazon SES account. Shared-account connection settings cannot be edited; use activate/deactivate and the limit-request endpoint for its other allowed actions.

patch/providers/{public_id}

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/providers/{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: provider.update)

Path parameters

public_idstring required

Sending account public ID

Example:dprov_clxxxxxxxxxxxxxxxxxxxxxxxxx

Headers

If-Matchstring

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

Request body

from_emailstring email nullable

Default From email address for an SMTP account. Connected Google and Microsoft accounts keep their authorised account address.

from_namestring nullable
namestring
percentageinteger
reply_to_emailstring email nullable
reply_to_namestring nullable
smtp_hoststring
smtp_passwordstring
smtp_portinteger
smtp_protocol'tls' | 'ssl' | 'none' | 'starttls'
smtp_usernamestring
tracking_domainstring nullable
variablesProviderVariables

Per-account string variables. PATCH omission preserves the current map, a supplied map replaces it, and an empty map clears it. Detail responses return an empty map when no variables are set.

Example request

{
  "from_email": "sender@example.com",
  "from_name": "Acme",
  "name": "Transactional SMTP",
  "percentage": 100,
  "quotas": {
    "per_day": {
      "max": 60,
      "min": 60
    },
    "per_hour": {
      "max": 60,
      "min": 60
    },
    "per_minute": {
      "max": 60,
      "min": 60
    },
    "per_second": {
      "max": 60,
      "min": 60
    }
  },
  "reply_to_email": "support@example.com",
  "reply_to_name": "Support",
  "smtp_host": "smtp.example.com",
  "smtp_password": "new-smtp-password",
  "smtp_port": 587,
  "smtp_protocol": "starttls",
  "smtp_username": "api-user",
  "tracking_domain": "click.example.com",
  "variables": {
    "signature_url": "https://example.com/signature"
  }
}

Response

Updated sending account

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "created_at": "2026-05-25T02:18:00Z",
    "id": "dprov_clxxxxxxxxxxxxxxxxxxxxxxxxx",
    "name": "Transactional SMTP",
    "percentage": 100,
    "quotas": {
      "per_day": {
        "max": 60,
        "min": 60
      },
      "per_hour": {
        "max": 60,
        "min": 60
      },
      "per_minute": {
        "max": 60,
        "min": 60
      },
      "per_second": {
        "max": 60,
        "min": 60
      }
    },
    "status": "active",
    "type": "smtp",
    "updated_at": "2026-05-25T02:18:00Z",
    "variables": {
      "signature_url": "https://example.com/signature"
    }
  }
}

Changes