channels

Get email sending identity

Read a business email sending identity and its DNS verification status.

Returns sending_domain: null when no identity is configured.

If the workspace has more than one email channel, pass business_id to choose the business.

Possible statuses: not_started, pending, verified, partially_verified, partially_failed, failed, temporary_failure.

While status is not 'verified', this refreshes the live status so polling reflects DNS propagation.

get/api/v1/email/sending-domain

Request

Base URL: https://app.blueticked.com
URL: https://app.blueticked.com/api/v1/email/sending-domain
Auth: HTTP bearer

Query parameters

business_idstring

Filter by business_id.

Response

Success

request_idstring required

Example response

{
  "sending_domain": {
    "id": "fb1c7505-7053-44da-bf3a-5b0e8949e81d",
    "domain": "mail.yourbusiness.co.za",
    "from_local_part": "accounts",
    "status": "pending",
    "records": [
      {
        "record": "DKIM",
        "name": "resend._domainkey",
        "type": "TXT",
        "value": "p=MIGf...",
        "status": "pending"
      }
    ]
  },
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.