Domains
Add a domain
Register one sending domain and return its next setup action.
POST
/api/v1/domainsOn this page
Authentication
Send a RouteKite API key as a Bearer token. This endpoint requires the domain:manage scope.
| Name | Type | Requirement | Description |
|---|---|---|---|
Authorization | string | Required | Bearer API key with the required workspace scope.Example: Bearer rk_your_key |
Content-Type | string | Required | Use application/json.Example: application/json |
Request body
| Name | Type | Requirement | Description |
|---|---|---|---|
domain | hostname | Required | A registrable domain such as example.com. |
Response
| Name | Type | Requirement | Description |
|---|---|---|---|
object | string | Always | Always domain. |
id | uuid | Always | Domain identifier. |
name | hostname | Always | Normalized sending domain. |
status | string | Always | waiting_for_dns, ready, needs_attention, or archived. |
sending_ready | boolean | Always | Whether verified Sending Addresses can be used. |
dns_records_url | string | Always | Route for the exact DNS records. |
last_checked_at | date-time | null | Always | Latest verification check. |
Manager authorization
The API key must have domain:manage and must have been created by a current workspace owner or admin.
Errors
| Status | Code | What it means | What to do |
|---|---|---|---|
| 401 | UNAUTHORIZED | The API key is invalid. | Check the Bearer header. |
| 403 | FORBIDDEN | The key cannot read sending configuration. | Use domain:read, domain:manage, or legacy email:send access. |
| 404 | DOMAIN_NOT_FOUND | The domain is not in this workspace. | Check the domain ID and API key workspace. |
| 429 | RATE_LIMITED | Too many requests were made. | Honor Retry-After before retrying. |
| 503 | SETUP_UNAVAILABLE | Configuration could not be loaded. | Retry after a short delay. |
| 409 | DOMAIN_ALREADY_EXISTS | The domain is already configured. | Use the existing domain or choose another. |
| 409 | DOMAIN_NOT_READY | DNS verification is incomplete. | Publish every required record and verify the domain. |
| 422 | SENDING_ADDRESS_INVALID | The address does not match the selected domain. | Use an address on the verified domain. |