Register a sending domain

Requires EDITOR. trackingSubdomain (if provided) must sit under the domain.

Authorizations

• SessionCookie

Parameters

Path Parameters

projectId

required

string

Tenant project id (row-level isolation on every query).

Request Body^required

Media typeapplication/json

object

domain

required

string

>= 3 characters <= 255 characters

trackingSubdomain

string | null

>= 3 characters <= 255 characters

Example^generated

json

{
  "domain": "example",
  "trackingSubdomain": "example"
}

Responses

201

Created domain (status/spfStatus/dkimStatus/dmarcStatus start ‘pending’).

Media typeapplication/json

object

domain

object

id

string

projectId

string

domain

string

trackingSubdomain

string | null

status

string

spfStatus

string

dkimStatus

string

dmarcStatus

string

dnsRecords

Array<object>

object

key

additional properties

any

lastCheckedAt

string | null format: date-time

createdAt

string format: date-time

updatedAt

string format: date-time

400

Invalid domain or trackingSubdomain (issues[] with path/message).

Media typeapplication/json

object

error

string

issues

Array<object>

object

path

string

message

string

Example^generated

json

{
  "error": "example",
  "issues": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

401

Not authenticated (no valid session/principal).

Media typeapplication/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

json

{
  "error": "example",
  "message": "example"
}

403

Authenticated but lacks the required project role.

Media typeapplication/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

json

{
  "error": "example",
  "message": "example"
}

409

Domain already registered for this project.

Media typeapplication/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

json

{
  "error": "example",
  "message": "example"
}