API reference

Domains.

Add a sending domain, read its DNS records and verify it. Every request needs an API key in the Authorization header; the reference overview covers keys, errors and rate limits.

List domains

GET/v1/domainsFull access key

List the sending domains the API key can use.

terminal

curl -X GET "https://app.usenotix.dev/api/v1/domains" \
  -H "Authorization: Bearer $NOTIX_API_KEY"

notix-js

import { Notix } from "notix-js";

const notix = new Notix(process.env.NOTIX_API_KEY);

const { data, error } = await notix.domains.list();

notix-sdk

from notix import Notix

notix = Notix()  # reads NOTIX_API_KEY

domains, _ = notix.domains.list()

usenotix/notix-php

use Notix\Notix;

$notix = new Notix(getenv('NOTIX_API_KEY'));

$domains = $notix->domains->list();

Responses

200Retrieve domains accessible by the API key

200 response fields
Field	Type	About
`id`required	`number`	The ID of the domain
`name`required	`string`	The name of the domain
`teamId`required	`number`	The ID of the team
`status`required	`string`	One of `NOT_STARTED`, `PENDING`, `SUCCESS`, `FAILED`, `TEMPORARY_FAILURE`.
`region`	`string`	Default `"us-east-1"`.
`clickTracking`	`boolean`	Default `false`.
`openTracking`	`boolean`	Default `false`.
`publicKey`required	`string`
`dkimStatus`	`string`	Can be null.
`spfDetails`	`string`	Can be null.
`createdAt`required	`string`
`updatedAt`required	`string`
`dmarcAdded`	`boolean`	Default `false`.
`isVerifying`	`boolean`	Default `false`.
`errorMessage`	`string`	Can be null.
`subdomain`	`string`	Can be null.
`verificationError`	`string`	Can be null.
`lastCheckedTime`	`string`	Can be null.
`dnsRecords`required	`object[]`
`dnsRecords[].type`required	`string`	DNS record type One of `MX`, `TXT`.
`dnsRecords[].name`required	`string`	DNS record name
`dnsRecords[].value`required	`string`	DNS record value
`dnsRecords[].ttl`required	`string`	DNS record TTL
`dnsRecords[].priority`	`string`	DNS record priority Can be null.
`dnsRecords[].status`required	`string`	One of `NOT_STARTED`, `PENDING`, `SUCCESS`, `FAILED`, `TEMPORARY_FAILURE`.
`dnsRecords[].recommended`	`boolean`	Whether the record is recommended

Add a domain

POST/v1/domainsFull access key

Add a sending domain. The response carries the SPF, DKIM and DMARC records to publish at your DNS provider.

Request body (JSON)
Field	Type	About
`name`required	`string`
`region`required	`string`

terminal

curl -X POST "https://app.usenotix.dev/api/v1/domains" \
  -H "Authorization: Bearer $NOTIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "region": "string"
}'

notix-js

import { Notix } from "notix-js";

const notix = new Notix(process.env.NOTIX_API_KEY);

const { data, error } = await notix.domains.create({ name: "mail.acme.com", region: "eu-west-1" });

notix-sdk

from notix import Notix

notix = Notix()  # reads NOTIX_API_KEY

domain, _ = notix.domains.create({"name": "mail.acme.com", "region": "eu-west-1"})

usenotix/notix-php

use Notix\Notix;

$notix = new Notix(getenv('NOTIX_API_KEY'));

$domain = $notix->domains->create(['name' => 'mail.acme.com', 'region' => 'eu-west-1']);

Responses

200Create a new domain

200 response fields
Field	Type	About
`id`required	`number`	The ID of the domain
`name`required	`string`	The name of the domain
`teamId`required	`number`	The ID of the team
`status`required	`string`	One of `NOT_STARTED`, `PENDING`, `SUCCESS`, `FAILED`, `TEMPORARY_FAILURE`.
`region`	`string`	Default `"us-east-1"`.
`clickTracking`	`boolean`	Default `false`.
`openTracking`	`boolean`	Default `false`.
`publicKey`required	`string`
`dkimStatus`	`string`	Can be null.
`spfDetails`	`string`	Can be null.
`createdAt`required	`string`
`updatedAt`required	`string`
`dmarcAdded`	`boolean`	Default `false`.
`isVerifying`	`boolean`	Default `false`.
`errorMessage`	`string`	Can be null.
`subdomain`	`string`	Can be null.
`verificationError`	`string`	Can be null.
`lastCheckedTime`	`string`	Can be null.
`dnsRecords`required	`object[]`
`dnsRecords[].type`required	`string`	DNS record type One of `MX`, `TXT`.
`dnsRecords[].name`required	`string`	DNS record name
`dnsRecords[].value`required	`string`	DNS record value
`dnsRecords[].ttl`required	`string`	DNS record TTL
`dnsRecords[].priority`	`string`	DNS record priority Can be null.
`dnsRecords[].status`required	`string`	One of `NOT_STARTED`, `PENDING`, `SUCCESS`, `FAILED`, `TEMPORARY_FAILURE`.
`dnsRecords[].recommended`	`boolean`	Whether the record is recommended

Get a domain

GET/v1/domains/{id}Full access key

Retrieve one domain with its DNS records and verification status.

Path parameters
Field	Type	About
`id`required	`number`

terminal

curl -X GET "https://app.usenotix.dev/api/v1/domains/<id>" \
  -H "Authorization: Bearer $NOTIX_API_KEY"

notix-js

import { Notix } from "notix-js";

const notix = new Notix(process.env.NOTIX_API_KEY);

const { data, error } = await notix.domains.get(12);

notix-sdk

from notix import Notix

notix = Notix()  # reads NOTIX_API_KEY

domain, _ = notix.domains.get(12)

usenotix/notix-php

use Notix\Notix;

$notix = new Notix(getenv('NOTIX_API_KEY'));

$domain = $notix->domains->get(12);

Responses

200Retrieve the domain

200 response fields
Field	Type	About
`id`required	`number`	The ID of the domain
`name`required	`string`	The name of the domain
`teamId`required	`number`	The ID of the team
`status`required	`string`	One of `NOT_STARTED`, `PENDING`, `SUCCESS`, `FAILED`, `TEMPORARY_FAILURE`.
`region`	`string`	Default `"us-east-1"`.
`clickTracking`	`boolean`	Default `false`.
`openTracking`	`boolean`	Default `false`.
`publicKey`required	`string`
`dkimStatus`	`string`	Can be null.
`spfDetails`	`string`	Can be null.
`createdAt`required	`string`
`updatedAt`required	`string`
`dmarcAdded`	`boolean`	Default `false`.
`isVerifying`	`boolean`	Default `false`.
`errorMessage`	`string`	Can be null.
`subdomain`	`string`	Can be null.
`verificationError`	`string`	Can be null.
`lastCheckedTime`	`string`	Can be null.
`dnsRecords`required	`object[]`
`dnsRecords[].type`required	`string`	DNS record type One of `MX`, `TXT`.
`dnsRecords[].name`required	`string`	DNS record name
`dnsRecords[].value`required	`string`	DNS record value
`dnsRecords[].ttl`required	`string`	DNS record TTL
`dnsRecords[].priority`	`string`	DNS record priority Can be null.
`dnsRecords[].status`required	`string`	One of `NOT_STARTED`, `PENDING`, `SUCCESS`, `FAILED`, `TEMPORARY_FAILURE`.
`dnsRecords[].recommended`	`boolean`	Whether the record is recommended

Verify a domain

PUT/v1/domains/{id}/verifyFull access key

Start a fresh check of the domain's DNS records. The answer returns at once; read the domain back for the result.

Path parameters
Field	Type	About
`id`required	`number`

terminal

curl -X PUT "https://app.usenotix.dev/api/v1/domains/<id>/verify" \
  -H "Authorization: Bearer $NOTIX_API_KEY"

notix-js

import { Notix } from "notix-js";

const notix = new Notix(process.env.NOTIX_API_KEY);

const { data, error } = await notix.domains.verify(12);

notix-sdk

from notix import Notix

notix = Notix()  # reads NOTIX_API_KEY

result, _ = notix.domains.verify(12)

usenotix/notix-php

use Notix\Notix;

$notix = new Notix(getenv('NOTIX_API_KEY'));

$result = $notix->domains->verify(12);

Responses

200Verify domain

200 response fields
Field	Type	About
`message`required	`string`

403Forbidden - API key doesn't have access to this domain

403 response fields
Field	Type	About
`error`required	`string`

404Domain not found

404 response fields
Field	Type	About
`error`required	`string`

Delete a domain

DELETE/v1/domains/{id}Full access key

Remove a sending domain. Mail can no longer be sent from it.

Path parameters
Field	Type	About
`id`required	`number`

terminal

curl -X DELETE "https://app.usenotix.dev/api/v1/domains/<id>" \
  -H "Authorization: Bearer $NOTIX_API_KEY"

notix-js

import { Notix } from "notix-js";

const notix = new Notix(process.env.NOTIX_API_KEY);

const { data, error } = await notix.domains.delete(12);

notix-sdk

from notix import Notix

notix = Notix()  # reads NOTIX_API_KEY

result, _ = notix.domains.delete(12)

usenotix/notix-php

use Notix\Notix;

$notix = new Notix(getenv('NOTIX_API_KEY'));

$result = $notix->domains->delete(12);

Responses

200Domain deleted successfully

200 response fields
Field	Type	About
`id`required	`number`
`success`required	`boolean`
`message`required	`string`

403Forbidden - API key doesn't have access

403 response fields
Field	Type	About
`error`required	`string`

404Domain not found

404 response fields
Field	Type	About
`error`required	`string`