Domains

Configure domain DNS

Sets up DNS records and mail services for an existing domain

post/domains/configure

Request

Base URL
https://api.customeros.ai
Auth
API key in header X-CUSTOMER-OS-API-KEY
TypeScript
https://skmtc.dev/customeros/apis/customeros-api/docs/domains/configure/post.ts
A function with typed inputs. Its response is checked against the schema.

domainstring

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

websitestring

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

Domain configured successfully

requestIdstring

statusstring

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

{
  "requestId": "1234567890abcdef",
  "status": "success"
}

Jul 17, 202673526747b270 Revision changes
- info
  endpoint added
Sep 10, 20241ee4ed170cfa Revision changes
- breaking
  api path removed without deprecation