Skip to main content
PATCH
/
domains
/
{id}
JavaScript
import Nuntly from '@nuntly/sdk';

const client = new Nuntly({
  apiKey: process.env['NUNTLY_API_KEY'], // This is the default and can be omitted
});

const domain = await client.domains.update('dns_01kabn43yqyxn2bx4ve84mczd3');

console.log(domain.id);
{
  "data": {
    "id": "<string>",
    "openTracking": true,
    "clickTracking": true
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The id of the domain

Example:

"dns_01kabn43yqyxn2bx4ve84mczd3"

Body

application/json

Domain capability toggles (sending, receiving, open tracking, click tracking).

openTracking
boolean

Emit an event for each recipient opens an email their email client

clickTracking
boolean

Emit an event for each time the recipient clicks a link in the email

sending
boolean

Enable or disable sending

receiving
boolean

Enable or disable receiving

Response

Successful response.

data
object
required