Create new domain

POST

api

domains

TypeScript

import Inbound from "inboundemail";

const inbound = new Inbound();
const result = await inbound.domains.create({
  domain: "example.com"
});

import requests

url = "https://inbound.new/api/e2/domains"

payload = { "domain": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({domain: '<string>'})
};

fetch('https://inbound.new/api/e2/domains', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://inbound.new/api/e2/domains",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'domain' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://inbound.new/api/e2/domains"

	payload := strings.NewReader("{\n  \"domain\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://inbound.new/api/e2/domains")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://inbound.new/api/e2/domains")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "domain": "<string>",
  "status": "pending",
  "canReceiveEmails": true,
  "hasMxRecords": true,
  "domainProvider": "<string>",
  "providerConfidence": "<string>",
  "dnsRecords": [
    {
      "type": "<string>",
      "name": "<string>",
      "value": "<string>",
      "isRequired": true,
      "description": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "mailFromDomain": "<string>",
  "mailFromDomainStatus": "<string>",
  "dnsConflict": {
    "hasConflict": true,
    "message": "<string>",
    "conflictType": "mx",
    "existingRecords": [
      {
        "type": "<string>",
        "value": "<string>"
      }
    ]
  },
  "parentDomain": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

Authorizations

Authorization

string

header

required

Your Inbound API key. Include it in the Authorization header as: Bearer

Body

domain

string

required

Required string length: 1 - 253

Response

Response for status 201

string

required

domain

string

required

status

enum<string>

required

Available options:

pending,

verified,

failed

canReceiveEmails

boolean

required

hasMxRecords

boolean

required

domainProvider

string · null · null

required

providerConfidence

string · null · null

required

dnsRecords

object[]

required

Show child attributes

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

mailFromDomain

string

mailFromDomainStatus

string

dnsConflict

object

Show child attributes

parentDomain

string

message

string

TypeScript

import Inbound from "inboundemail";

const inbound = new Inbound();
const result = await inbound.domains.create({
  domain: "example.com"
});

import requests

url = "https://inbound.new/api/e2/domains"

payload = { "domain": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({domain: '<string>'})
};

fetch('https://inbound.new/api/e2/domains', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://inbound.new/api/e2/domains",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'domain' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://inbound.new/api/e2/domains"

	payload := strings.NewReader("{\n  \"domain\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://inbound.new/api/e2/domains")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://inbound.new/api/e2/domains")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "domain": "<string>",
  "status": "pending",
  "canReceiveEmails": true,
  "hasMxRecords": true,
  "domainProvider": "<string>",
  "providerConfidence": "<string>",
  "dnsRecords": [
    {
      "type": "<string>",
      "name": "<string>",
      "value": "<string>",
      "isRequired": true,
      "description": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "mailFromDomain": "<string>",
  "mailFromDomainStatus": "<string>",
  "dnsConflict": {
    "hasConflict": true,
    "message": "<string>",
    "conflictType": "mx",
    "existingRecords": [
      {
        "type": "<string>",
        "value": "<string>"
      }
    ]
  },
  "parentDomain": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

Overview

Domains

Endpoints

Email Addresses

Attachments

Authentication

Emails

Inbox

Mailboxes

Spam Filter

Guard

Webhooks

Create new domain

Authorizations

Body

Response