Onboard a domain to Email Sending

POST

/api/v1/email-sending/domains

curl --request POST \
  --url https://digize.com/api/v1/email-sending/domains \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "domain": "example", "replaceMailRecords": true }'

• Digize

Onboards an active full-setup domain, or a subdomain of one, to Email Sending: the MX, SPF, DKIM and DMARC records it needs go on the zone, and Email Routing is turned on for it so replies come into Conversations. A domain that gets its mail elsewhere is refused unless replaceMailRecords says to replace those MX records.

Needs the sites:write permission.

Authorizations

• apiKey
• bearer

Parameters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Body^required

Media typeapplication/json

object

domain

required

string

>= 3 characters <= 253 characters

replaceMailRecords

boolean

Example ^generated

{
  "domain": "example",
  "replaceMailRecords": true
}

Responses

201

Done

Media typeapplication/json

object

id

required

string

domain

required

string

zoneDomain

required

string

status

required

string

Allowed values: active pending_dns verifying failed

records

required

Array<object>

object

type

required

string

Allowed values: CNAME TXT MX

name

required

string

value

required

string

priority

number

status

required

string

Allowed values: found missing mismatch

purpose

required

string

optional

boolean

error

required

string | null

addedAt

required

string format: date-time

verifiedAt

required

Any of:

string

string format: date-time

null

null

checkedAt

required

string format: date-time

emailPreview

required

boolean

dropSuppressed

required

boolean

deliveryEvents

required

boolean

daily

required

Array<number>

reputation

required

object

status

required

string

Allowed values: healthy warning at_risk

metrics

required

Array<object>

object

id

required

string

Allowed values: bounce spam_rejection complaint delivery

week

required

number

day

required

number

status

required

string

Allowed values: healthy warning at_risk

sent

required

number

Example

{
  "status": "active",
  "records": [
    {
      "type": "CNAME",
      "status": "found"
    }
  ],
  "reputation": {
    "status": "healthy",
    "metrics": [
      {
        "id": "bounce",
        "status": "healthy"
      }
    ]
  }
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

422

The Idempotency-Key was used with a different request.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}