• Notification API

Custom Domain

post

Create a custom domain

Create a custom domain

networkobject
idstring

required

domainstring

required

Min Length
1
Max Length
255
subdomainstring
Min Length
1
Max Length
255
customDkimSelectorstring
Min Length
2
Max Length
3
defaultFromobject

required

emailstring

required

Format
email
namestring

required

Min Length
1
Max Length
255
defaultReplyToobject

required

emailstring

required

Format
email
namestring

required

Min Length
1
Max Length
255

Responses

Request examples

{
  "network": {
    "id": "string"
  },
  "domain": "string",
  "subdomain": "string",
  "customDkimSelector": "string",
  "defaultFrom": {
    "email": "alice@example.com",
    "name": "string"
  },
  "defaultReplyTo": {
    "email": "alice@example.com",
    "name": "string"
  }
}

Response examples

Custom domain created

{
  "id": "string",
  "domain": "string",
  "subdomain": "string",
  "customDkimSelector": "string",
  "defaultFrom": {
    "email": "alice@example.com",
    "name": "string"
  },
  "defaultReplyTo": {
    "email": "alice@example.com",
    "name": "string"
  },
  "dnsRecords": [
    {
      "valid": true,
      "type": "string",
      "host": "string",
      "data": "string"
    }
  ],
  "status": "Processing",
  "createdAt": 123.0,
  "updatedAt": 123.0
}
delete

Delete custom domain

Delete custom domain

idstring

required

Custom domain ID

Responses

Response examples

Custom domain deleted

Empty response

post

Validate custom domain

Validate custom domain

networkobject
idstring

required

Responses

Request examples

{
  "network": {
    "id": "string"
  }
}

Response examples

Received the request, validating custom domain

Empty response

Was this page helpful?