Skip to content
VaartixVaartix Docs

Add a domain

POST
/domains
curl --request POST \
  --url https://api.vaartix.com/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "acme.in" }'

Registers a domain and returns the DNS records to publish. Vaartix checks the records every 10 minutes for 72 hours; call POST /domains/{id}/verify to check immediately. A domain can belong to one team only. The Free plan allows one domain.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required

The domain or subdomain you will send from.

string

Example 

acme.in

Responses

Section titled “Responses”

201

Section titled “201”

The domain, with its DNS records.

Media typeapplication/json
object
id
string
name
string
status
string
Allowed values: pending verified failed temporary_failure
region
string
records

3 DKIM CNAMEs, the MAIL FROM MX and SPF TXT, and a recommended DMARC TXT.

Array<object>
object
type
string
Allowed values: CNAME MX TXT
name
string
value
string
priority

MX records only.

integer
status

Not set for the recommended DMARC record.

string
Allowed values: pending verified failed
openTracking
boolean
clickTracking
boolean
verifiedAt
string | null format: date-time
lastCheckedAt
string | null format: date-time
createdAt
string format: date-time

Example 

{
  "id": "dom_5bvatg1v837anztd",
  "name": "acme.in",
  "status": "pending",
  "region": "ap-south-1",
  "records": [
    {
      "type": "CNAME",
      "name": "send.acme.in",
      "value": "feedback-smtp.ap-south-1.amazonses.com",
      "status": "pending"
    }
  ]
}

400

Section titled “400”

validation_error: the request is invalid. The message says which field and why.

Media typeapplication/json
object
error
required
object
type
required

Stable, machine-readable error type.

string
Allowed values: validation_error unauthorized forbidden not_found conflict rate_limited daily_quota_exceeded domain_not_verified invalid_from_address account_paused idempotency_conflict bad_request internal_error
message
required

Human-readable explanation, safe to show to developers.

string

Example 

{
  "error": {
    "type": "validation_error",
    "message": "to: \"priya@\" is not a valid email address."
  }
}

401

Section titled “401”

unauthorized: the API key is missing, invalid or revoked.

Media typeapplication/json
object
error
required
object
type
required

Stable, machine-readable error type.

string
Allowed values: validation_error unauthorized forbidden not_found conflict rate_limited daily_quota_exceeded domain_not_verified invalid_from_address account_paused idempotency_conflict bad_request internal_error
message
required

Human-readable explanation, safe to show to developers.

string

Example 

{
  "error": {
    "type": "validation_error"
  }
}

403

Section titled “403”

forbidden: your plan does not allow more domains, or the key is send-only.

Media typeapplication/json
object
error
required
object
type
required

Stable, machine-readable error type.

string
Allowed values: validation_error unauthorized forbidden not_found conflict rate_limited daily_quota_exceeded domain_not_verified invalid_from_address account_paused idempotency_conflict bad_request internal_error
message
required

Human-readable explanation, safe to show to developers.

string

Example 

{
  "error": {
    "type": "validation_error"
  }
}

409

Section titled “409”

conflict: the domain is already registered with Vaartix.

Media typeapplication/json
object
error
required
object
type
required

Stable, machine-readable error type.

string
Allowed values: validation_error unauthorized forbidden not_found conflict rate_limited daily_quota_exceeded domain_not_verified invalid_from_address account_paused idempotency_conflict bad_request internal_error
message
required

Human-readable explanation, safe to show to developers.

string

Example 

{
  "error": {
    "type": "validation_error"
  }
}