Email

4 endpoints, each with examples that open in the console prefilled.

All resourcesGuide: Email

GET/api/v1/email/sending-domainchannels:readTry in console

Get email sending identity

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

Query parameters

business_id

string

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.

curl -X GET "https://app.blueticked.com/api/v1/email/sending-domain" \
  -H "Authorization: Bearer $BLUETICKED_API_KEY"

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"
}

POST/api/v1/email/sending-domainchannels:writeTry in console

Add an email sending identity

Register a Blueticked-managed sending identity and get back the DNS records to add. Emails use that sender once it verifies.

Query parameters

business_id

string

Body parameters

domainrequired	string
from_local_partrequired	string

Add the returned DNS records at your domain registrar, then call the verify endpoint.
If the workspace has more than one email channel, pass business_id to choose the business.
One sending identity per business - remove the current one (DELETE) before adding another.
A domain the email provider already has is never taken over. Another workspace's or business's domain answers 409 conflict with details.reason domain_in_use_elsewhere or domain_in_use_by_business. One no workspace holds answers 409 conflict with domain_registered_unclaimed: support releases it, and a retry gets the same answer. If the holder could not be read, it answers 503 service_unavailable with domain_holder_unchecked.
A timeout or a provider 5xx is answered as could not confirm. A retried add of a domain the provider did take answers domain_registered_unclaimed: contact support with request_id.
Until verified, emails keep sending from the shared Blueticked address; once verified they send from from_local_part@domain.

curl -X POST "https://app.blueticked.com/api/v1/email/sending-domain" \
  -H "Authorization: Bearer $BLUETICKED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "domain": "mail.yourbusiness.co.za",
  "from_local_part": "accounts"
}'

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"
      },
      {
        "record": "SPF",
        "name": "send",
        "type": "MX",
        "value": "feedback-smtp.eu-west-1.amazonses.com",
        "priority": 10,
        "status": "pending"
      }
    ]
  },
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

POST/api/v1/email/sending-domain/verifychannels:writeTry in console

Verify the email sending identity

Trigger a DNS re-check now. When it returns verified, every send uses the verified sender address.

Query parameters

business_id

string

Call this after adding the DNS records; DNS can take minutes to hours to propagate.
If the workspace has more than one email channel, pass business_id to choose the business.

curl -X POST "https://app.blueticked.com/api/v1/email/sending-domain/verify" \
  -H "Authorization: Bearer $BLUETICKED_API_KEY"

Response

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

DELETE/api/v1/email/sending-domainchannels:writeTry in console

Remove the email sending identity

Remove the custom sending identity and revert the workspace to the shared Blueticked sender.

Query parameters

business_id

string

If the workspace has more than one email channel, pass business_id to choose the business.
Idempotent on the provider side: a failed remote delete still reverts the channel locally.

curl -X DELETE "https://app.blueticked.com/api/v1/email/sending-domain" \
  -H "Authorization: Bearer $BLUETICKED_API_KEY"

Response

{
  "removed": "mail.yourbusiness.co.za",
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}