POST
/
domains
curl --request POST \
  --url https://api.customeros.ai/domains \
  --header 'Content-Type: application/json' \
  --header 'X-CUSTOMER-OS-API-KEY: <api-key>' \
  --data '{
  "domain": "<string>",
  "website": "<string>"
}'
{
  "domain": {
    "createdDate": "<string>",
    "domain": "<string>",
    "expiredDate": "<string>",
    "nameservers": [
      "<string>"
    ]
  },
  "requestId": "1234567890abcdef",
  "status": "success"
}

Authorizations

​
X-CUSTOMER-OS-API-KEY
string
header
required

Body

application/json
Domain registration details

Request payload for registering a new domain for mail services

​
domain
string

Domain name to register required: true pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{1,61}[a-zA-Z0-9].[a-zA-Z]{2,}$ example: example.com

​
website
string

Website URL for domain configuration required: true format: uri example: https://www.example.com

Response

201
application/json
Domain registered and configured successfully

Response containing domain details and status

​
domain
object

Domain information required: true

​
requestId
string
​
status
string

Status indicates the result of the operation ("success" or "error")

List active domainsConfigure domain DNS