Documentation/Create a domain

Create a domain

Add a sending or receiving domain to the selected regional project.

POST/domains

Body parameters

FieldTypeDescription

namerequiredstring (hostname)

tlsstring

Values: "opportunistic", "enforced".

capabilitiesobject

capabilities.sendingstring

Values: "enabled", "disabled".

capabilities.receivingstring

Values: "enabled", "disabled".

`201` response

Domain

FieldTypeDescription

idrequiredstring

namerequiredstring

statusrequiredstring

regionrequiredstring

recordsrequiredarray

tlsstring

managed_unsubscribe_defaultboolean

Whether omitted or null email unsubscribe values enable Boundry-managed RFC 8058 headers.

capabilitiesobject

request.ts

typescript

curl --request POST 'https://api.au.boundry.dev/domains' \
+  -H 'Authorization: Bearer $BOUNDRY_API_KEY' \
+  -H 'Content-Type: application/json' \
+  --data '{"name":"mail.example.com","capabilities":{"sending":true,"receiving":false}}'

import { Boundry } from "boundry-sdk";

const boundry = new Boundry({
  apiKey: process.env.BOUNDRY_API_KEY!,
});

const response = await boundry.api.createDomain({
  name: "mail.example.com",
  capabilities: {
    sending: true,
    receiving: false
  }
});

from boundry import Boundry

boundry = Boundry(api_key="$BOUNDRY_API_KEY")
response = boundry.api.create_domain({
  "name": "mail.example.com",
  "capabilities": {
    "sending": true,
    "receiving": false
  }
})

response.json201 response

application/json

{
  "id": "string",
  "name": "string",
  "status": "string",
  "region": "string",
  "tls": "string",
  "managed_unsubscribe_default": true
}