Get a sending account - Sendmux

Get a sending account

curl --request GET \
  --url https://app.sendmux.ai/api/v1/providers/{public_id} \
  --header 'Authorization: Bearer <token>'

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "id": "dprov_clxxxxxxxxxxxxxxxxxxxxxxxxx",
    "name": "Transactional SMTP",
    "type": "smtp",
    "status": "active",
    "status_reason": "<string>",
    "is_active": true,
    "is_shared": true,
    "is_editable": true,
    "allowed_actions": {
      "update": true,
      "delete": true,
      "activate": true,
      "deactivate": true,
      "test": true
    },
    "smtp_host": "<string>",
    "smtp_port": 123,
    "smtp_protocol": "<string>",
    "smtp_username": "<string>",
    "has_smtp_password": true,
    "from_email": "<string>",
    "from_name": "<string>",
    "reply_to_email": "<string>",
    "reply_to_name": "<string>",
    "oauth_email": "<string>",
    "has_refresh_token": true,
    "quotas": {
      "per_second": {
        "min": 60,
        "max": 60
      },
      "per_minute": {
        "min": 60,
        "max": 60
      },
      "per_hour": {
        "min": 60,
        "max": 60
      },
      "per_day": {
        "min": 60,
        "max": 60
      }
    },
    "percentage": 100,
    "tracking_domain": "<string>",
    "created_at": "2026-05-25T02:18:00Z",
    "updated_at": "2026-05-25T02:18:00Z",
    "last_tested_at": "<string>",
    "last_used_at": "<string>"
  }
}

GET

/

providers

/

{public_id}

Get a sending account

curl --request GET \
  --url https://app.sendmux.ai/api/v1/providers/{public_id} \
  --header 'Authorization: Bearer <token>'

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "id": "dprov_clxxxxxxxxxxxxxxxxxxxxxxxxx",
    "name": "Transactional SMTP",
    "type": "smtp",
    "status": "active",
    "status_reason": "<string>",
    "is_active": true,
    "is_shared": true,
    "is_editable": true,
    "allowed_actions": {
      "update": true,
      "delete": true,
      "activate": true,
      "deactivate": true,
      "test": true
    },
    "smtp_host": "<string>",
    "smtp_port": 123,
    "smtp_protocol": "<string>",
    "smtp_username": "<string>",
    "has_smtp_password": true,
    "from_email": "<string>",
    "from_name": "<string>",
    "reply_to_email": "<string>",
    "reply_to_name": "<string>",
    "oauth_email": "<string>",
    "has_refresh_token": true,
    "quotas": {
      "per_second": {
        "min": 60,
        "max": 60
      },
      "per_minute": {
        "min": 60,
        "max": 60
      },
      "per_hour": {
        "min": 60,
        "max": 60
      },
      "per_day": {
        "min": 60,
        "max": 60
      }
    },
    "percentage": 100,
    "tracking_domain": "<string>",
    "created_at": "2026-05-25T02:18:00Z",
    "updated_at": "2026-05-25T02:18:00Z",
    "last_tested_at": "<string>",
    "last_used_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-None-Match

string

Weak ETag from a previous response. Returns 304 when unchanged.

Path Parameters

public_id

string

required

Sending account public ID

Example:

"dprov_clxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

Sending account

ok

enum<boolean>

required

Available options:

true

meta

object

required

Hide child attributes

meta.request_id

string

required

Example:

"req_clxxxxxxxxxxxxxxxxxxxxxxxxx"

data

object

required

Hide child attributes

data.id

string

required

Sending account public ID

Example:

"dprov_clxxxxxxxxxxxxxxxxxxxxxxxxx"

data.name

string

required

Display name

Example:

"Transactional SMTP"

data.type

enum<string>

required

Sending account type. amazon_ses is the shared managed account.

Available options:

smtp,

gmail_api,

outlook_api,

amazon_ses

Example:

"smtp"

data.status

enum<string>

required

Current sending account status.

Available options:

active,

inactive,

error,

pending

Example:

"active"

data.status_reason

string | null

required

Public-safe reason for the current status.

data.is_active

boolean

required

Whether this account is enabled for sending.

data.is_shared

boolean

required

True for the team's shared Amazon SES account.

data.is_editable

boolean

required

False when the account is platform-managed.

data.allowed_actions

object

required

Hide child attributes

data.allowed_actions.update

boolean

required

data.allowed_actions.delete

boolean

required

data.allowed_actions.activate

boolean

required

data.allowed_actions.deactivate

boolean

required

data.allowed_actions.test

boolean

required

data.smtp_host

string | null

required

SMTP host for custom SMTP accounts.

data.smtp_port

integer | null

required

SMTP port for custom SMTP accounts.

data.smtp_protocol

string | null

required

SMTP security mode.

data.smtp_username

string | null

required

SMTP username for custom SMTP accounts.

data.has_smtp_password

boolean

required

Whether a custom SMTP password is stored.

data.from_email

string | null

required

Default From email address.

data.from_name

string | null

required

Default From display name.

data.reply_to_email

string | null

required

Default Reply-To email address.

data.reply_to_name

string | null

required

Default Reply-To display name.

data.oauth_email

string | null

required

Connected account email for OAuth accounts.

data.has_refresh_token

boolean

required

Whether an OAuth account has an active connection token.

data.quotas

object

required

Hide child attributes

data.quotas.per_second

object

required

Hide child attributes

data.quotas.per_second.min

integer

required

Example:

60

data.quotas.per_second.max

integer

required

Example:

60

data.quotas.per_minute

object

required

Hide child attributes

data.quotas.per_minute.min

integer

required

Example:

60

data.quotas.per_minute.max

integer

required

Example:

60

data.quotas.per_hour

object

required

Hide child attributes

data.quotas.per_hour.min

integer

required

Example:

60

data.quotas.per_hour.max

integer

required

Example:

60

data.quotas.per_day

object

required

Hide child attributes

data.quotas.per_day.min

integer

required

Example:

60

data.quotas.per_day.max

integer

required

Example:

60

data.percentage

integer | null

required

Routing weight percentage.

Example:

100

data.tracking_domain

string | null

required

Custom tracking hostname.

data.created_at

string

required

ISO 8601 creation timestamp

Example:

"2026-05-25T02:18:00Z"

data.updated_at

string

required

ISO 8601 last update timestamp

Example:

"2026-05-25T02:18:00Z"

data.last_tested_at

string | null

required

Last connection test timestamp.

data.last_used_at

string | null

required

Last send timestamp.

Create an SMTP sending account

Update a sending account