Change a domain's settings
Turn click tracking and open tracking on or off for one domain, as the Tracking card on the domain's page does.
https://app.usenotix.dev/api/v1/domains/{id}Needs a full access key. Sending access keys cannot call this. Key permissions lists the extra rules some calls have.
Turn click tracking and open tracking on or off for one domain, as the Tracking card on the domain's page does. Give clickTracking, openTracking or both, as true or false; a setting left out is unchanged, and an empty body answers 400. Click tracking sends each link through Notix to count clicks; open tracking adds a tracking pixel to count opens, which can lower delivery. The change applies to mail sent from now on, and a domain.updated webhook event is sent. Settings already as asked are answered as they are, with nothing written and no event. Nothing else about the domain can be changed here: not its sending state, region or DNS records.
Who can call it
Full access keys. A key limited to one domain may change that domain only; any other id answers 404. Read only, send-only and live AI keys answer 403 SCOPE_DENIED. Every team member can change these settings on the dashboard, so the key may have been made by any member. Notix's own domains answer 403. Every change is recorded in the key's audit log (GET /v1/audit-log) with the domain's id and the settings given.
The team can change domain settings 30 times a minute through the API; past that the answer is 429 with Retry-After. Calls with a malformed body or id count too. When Notix cannot count the calls the answer is 503 SERVICE_UNAVAILABLE (try again shortly), never a 429.
Path parameters
Minimum 0. Maximum 2147483647.
Body parameters
Track the links in this domain's emails: each link is sent through Notix to count clicks.
Add a tracking pixel to every email from this domain to count opens. It can lower delivery, and some mailbox providers open mail on their own.
Headers
Bearer followed by your API key.
Errors
No setting given, a field the route does not know, a value that is not true or false, or a body not sent as JSON.
`SCOPE_DENIED`: a read only, send-only or live AI key. Or a domain that belongs to Notix.
No domain with this id for the calling team, or a key limited to one domain asked about another.
The team changed domain settings 30 times in the last minute.
Notix cannot count the team's calls just now; try again shortly.
Every error has the same shape. See all error codes.
curl -X PATCH "https://app.usenotix.dev/api/v1/domains/<id>" \
-H "Authorization: Bearer $NOTIX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"clickTracking": true,
"openTracking": true
}'
import { Notix } from "notix-js";
const notix = new Notix(process.env.NOTIX_API_KEY);
const { data, error } = await notix.domains.updateSettings(12, { clickTracking: true, openTracking: false });
{
"id": 1,
"name": "mail.example.com",
"clickTracking": true,
"openTracking": true,
"updatedAt": "string"
}