Skip to main content
POST
/
domains
TypeScript
import Nuntly from '@nuntly/sdk';

const client = new Nuntly({
  apiKey: 'My API Key',
});

const domain = await client.domains.create({ name: 'acme.com', region: 'eu-west-1' });

console.log(domain.id);
{
  "data": {
    "id": "dns_01jh8xggryggczvjv4xfff4rwn",
    "org_id": "org_01jh6jk82zjq9deye73h0mzcaq",
    "name": "info.tomlinson.ai",
    "status": "bootstrapping",
    "sending_status": "disabled",
    "status_at": "2025-01-10T20:11:55.038Z",
    "created_at": "2025-01-10T20:11:55.038Z",
    "modified_at": "2025-01-10T20:11:55.038Z",
    "kind": "domain",
    "sending_records": [
      {
        "name": "nuntly012._domainkey.info",
        "fullname": "nuntly012._domainkey.info.tomlinson.ai",
        "type": "TXT",
        "ttl": "Auto",
        "group": "DKIM",
        "selector": "nuntly012",
        "value": "p=MIIBIjAxxx",
        "region": "eu-west-1",
        "status": "bootstrapping",
        "status_at": "2025-01-10T20:11:55.038Z",
        "kind": "record"
      },
      {
        "name": "nuntly012.info",
        "fullname": "nuntly012.info.tomlinson.ai",
        "type": "TXT",
        "ttl": "Auto",
        "group": "SPF",
        "value": "v=spf1 include:amazonses.com ~all",
        "region": "eu-west-1",
        "status": "bootstrapping",
        "status_at": "2025-01-10T20:11:55.038Z",
        "kind": "record"
      },
      {
        "name": "_dmarc",
        "fullname": "_dmarc.info.tomlinson.ai",
        "type": "TXT",
        "ttl": "Auto",
        "group": "DMARC",
        "value": "v=DMARC1; p=none;",
        "region": "eu-west-1",
        "status": "bootstrapping",
        "status_at": "2025-01-10T20:11:55.038Z",
        "kind": "record"
      },
      {
        "name": "nuntly012.info",
        "fullname": "nuntly012.info.tomlinson.ai",
        "type": "MX",
        "ttl": "Auto",
        "group": "MX",
        "priority": "10",
        "value": "feedback-smtp.eu-west-1.amazonses.com",
        "region": "eu-west-1",
        "status": "bootstrapping",
        "status_at": "2025-01-10T20:11:55.038Z",
        "kind": "record"
      }
    ],
    "region": "eu-west-1",
    "open_tracking": false,
    "click_tracking": false
  }
}

Authorizations

Authorization
string
header
required

Bearer HTTP authentication. Allowed headers Authorization: Bearer <API_KEY>

Body

application/json
name
string
required

The name of the domain. For example: 'email.mycompany.com'

region
enum<string>
required

The region of the related data

Available options:
eu-west-1

Response

A successful response

data
object
Example:
{
"id": "dns_01jh8xggryggczvjv4xfff4rwn",
"org_id": "org_01jh6jk82zjq9deye73h0mzcaq",
"name": "info.tomlinson.ai",
"status": "bootstrapping",
"sending_status": "disabled",
"status_at": "2025-01-10T20:11:55.038Z",
"created_at": "2025-01-10T20:11:55.038Z",
"modified_at": "2025-01-10T20:11:55.038Z",
"kind": "domain",
"sending_records": [
{
"name": "nuntly012._domainkey.info",
"fullname": "nuntly012._domainkey.info.tomlinson.ai",
"type": "TXT",
"ttl": "Auto",
"group": "DKIM",
"selector": "nuntly012",
"value": "p=MIIBIjAxxx",
"region": "eu-west-1",
"status": "bootstrapping",
"status_at": "2025-01-10T20:11:55.038Z",
"kind": "record"
},
{
"name": "nuntly012.info",
"fullname": "nuntly012.info.tomlinson.ai",
"type": "TXT",
"ttl": "Auto",
"group": "SPF",
"value": "v=spf1 include:amazonses.com ~all",
"region": "eu-west-1",
"status": "bootstrapping",
"status_at": "2025-01-10T20:11:55.038Z",
"kind": "record"
},
{
"name": "_dmarc",
"fullname": "_dmarc.info.tomlinson.ai",
"type": "TXT",
"ttl": "Auto",
"group": "DMARC",
"value": "v=DMARC1; p=none;",
"region": "eu-west-1",
"status": "bootstrapping",
"status_at": "2025-01-10T20:11:55.038Z",
"kind": "record"
},
{
"name": "nuntly012.info",
"fullname": "nuntly012.info.tomlinson.ai",
"type": "MX",
"ttl": "Auto",
"group": "MX",
"priority": "10",
"value": "feedback-smtp.eu-west-1.amazonses.com",
"region": "eu-west-1",
"status": "bootstrapping",
"status_at": "2025-01-10T20:11:55.038Z",
"kind": "record"
}
],
"region": "eu-west-1",
"open_tracking": false,
"click_tracking": false
}
I