Skip to main content
POST
/
domains
Add a sending domain
curl --request POST \
  --url https://api.arkhq.io/v1/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "notifications.myapp.com"
}
'
{
  "success": true,
  "data": {
    "id": "123",
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "mail.example.com",
    "verified": true,
    "dnsRecords": {
      "spf": {
        "type": "TXT",
        "name": "mail.example.com",
        "value": "v=spf1 include:spf.arkhq.io ~all",
        "status": "OK"
      },
      "dkim": {
        "type": "TXT",
        "name": "mail.example.com",
        "value": "v=spf1 include:spf.arkhq.io ~all",
        "status": "OK"
      },
      "returnPath": {
        "type": "TXT",
        "name": "mail.example.com",
        "value": "v=spf1 include:spf.arkhq.io ~all",
        "status": "OK"
      }
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "verifiedAt": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}

Authorizations

Authorization
string
header
required

Use your API key from arkhq.io/org/credentials

Authorization: Bearer YOUR_API_KEY

Body

application/json
name
string
required

Domain name (e.g., "mail.example.com")

Minimum string length: 1
Example:

"mail.mycompany.com"

Response

Domain added

success
boolean
required
data
object
required
meta
object
required