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.
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.
Request
- Base URL: https://app.blueticked.com
- URL: https://app.blueticked.com/api/v1/email/sending-domain
- Auth: HTTP bearer
Query parameters
Filter by business_id.
Request body
Example request
{
"domain": "mail.yourbusiness.co.za",
"from_local_part": "accounts"
}Response
Success
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.