Skip to content
AI Inbx
Esc
↑↓navigate↵open⌘Jpreview

Update domain tracking settings

Updates whether opens and clicks are tracked on mail sent from the domain. Applies to every send from it that does not say otherwise in tracking, from the next one to leave. At least one field is required.

PATCH/domains/{domain_id}
Authorization
AuthorizationBearer token (API key) · headerrequired

Pass an AI Inbx API key as a Bearer token.

Path parameters
domain_idstringrequired

The prefixed domain ID.

matches ^[a-z]+_[0-9a-f]{32}$
Header parameters
AIInbx-Workspacestring

Workspace id from GET /workspaces, for an OAuth token that reaches several.

min length 1
Request body
requiredapplication/json
track_opensboolean

Whether opens are tracked on mail sent from the domain.

track_clicksboolean

Whether links are rewritten to track clicks on mail sent from the domain.

regionstring

Move a domain that has not verified yet to another region. Its MX and return-path records change with it and start over as pending; DKIM does not. 409 region_fixed once it is verified, or on a subdomain.

Allowed:eu-central-1us-east-1
Responses
200

Success.

idstringrequired
matches ^[a-z]+_[0-9a-f]{32}$
namestringrequired
regionstringrequired

Where the domain's mail is handled today. A domain carried over from the previous aiinbx reports us-east-1 until its records verify here, then the region chosen for it.

Allowed:eu-central-1us-east-1
space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties
Any of:
string
string
null
null
parent_idstring | nullrequired

The wildcard this subdomain is filed under, when it is one.

Show properties
Any of:
string
string
null
null
providedbooleanrequired

Whether this is the domain the workspace was given — <slug>.aiinbx.app. Verified through our own zone, so it has no records and cannot be deleted.

verified_atstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
created_atstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
trackingobjectrequired
Show properties
opensbooleanrequired
clicksbooleanrequired
recordsobject[]
Show properties
Array of object
purposestringrequired
Allowed:SPFDKIMDMARCRETURN_PATHINBOUND
typestringrequired
Allowed:MXTXTCNAME
namestringrequired
valuestringrequired
ttlintegerrequired
min 0 · max 9007199254740991
statestringrequired
Allowed:pendingverifiedmissing
last_checked_atstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
400

The request is invalid.

typestringrequired
titlestringrequired
statusintegerrequired
min -9007199254740991 · max 9007199254740991
detailstringrequired
codestringrequired
request_idstringrequired
issuesobject[]
Show properties
Array of object
pathstringrequired
messagestringrequired
401

The API key is missing or invalid.

typestringrequired
titlestringrequired
statusintegerrequired
min -9007199254740991 · max 9007199254740991
detailstringrequired
codestringrequired
request_idstringrequired
issuesobject[]
Show properties
Array of object
pathstringrequired
messagestringrequired
402

The workspace has no plan (plan_required), or its plan's allowance is used up (allowance_reached).

typestringrequired
titlestringrequired
statusintegerrequired
min -9007199254740991 · max 9007199254740991
detailstringrequired
codestringrequired
request_idstringrequired
issuesobject[]
Show properties
Array of object
pathstringrequired
messagestringrequired
403

The API key or token does not have the required scope, or the token is connected as an inbox and the operation is not one an inbox may use.

typestringrequired
titlestringrequired
statusintegerrequired
min -9007199254740991 · max 9007199254740991
detailstringrequired
codestringrequired
request_idstringrequired
issuesobject[]
Show properties
Array of object
pathstringrequired
messagestringrequired
404

The requested resource does not exist.

typestringrequired
titlestringrequired
statusintegerrequired
min -9007199254740991 · max 9007199254740991
detailstringrequired
codestringrequired
request_idstringrequired
issuesobject[]
Show properties
Array of object
pathstringrequired
messagestringrequired
409

The request conflicts with the resource's current state.

typestringrequired
titlestringrequired
statusintegerrequired
min -9007199254740991 · max 9007199254740991
detailstringrequired
codestringrequired
request_idstringrequired
issuesobject[]
Show properties
Array of object
pathstringrequired
messagestringrequired
413

The request body or attachments are too large.

typestringrequired
titlestringrequired
statusintegerrequired
min -9007199254740991 · max 9007199254740991
detailstringrequired
codestringrequired
request_idstringrequired
issuesobject[]
Show properties
Array of object
pathstringrequired
messagestringrequired
415

The request body is not JSON.

typestringrequired
titlestringrequired
statusintegerrequired
min -9007199254740991 · max 9007199254740991
detailstringrequired
codestringrequired
request_idstringrequired
issuesobject[]
Show properties
Array of object
pathstringrequired
messagestringrequired
422

The request body failed validation.

typestringrequired
titlestringrequired
statusintegerrequired
min -9007199254740991 · max 9007199254740991
detailstringrequired
codestringrequired
request_idstringrequired
issuesobject[]
Show properties
Array of object
pathstringrequired
messagestringrequired
429

The organisation's request budget is spent (too_many_requests), or an upstream mail provider is throttling (rate_limited).

typestringrequired
titlestringrequired
statusintegerrequired
min -9007199254740991 · max 9007199254740991
detailstringrequired
codestringrequired
request_idstringrequired
issuesobject[]
Show properties
Array of object
pathstringrequired
messagestringrequired
500

An internal error occurred.

typestringrequired
titlestringrequired
statusintegerrequired
min -9007199254740991 · max 9007199254740991
detailstringrequired
codestringrequired
request_idstringrequired
issuesobject[]
Show properties
Array of object
pathstringrequired
messagestringrequired
502

An upstream mail provider failed.

typestringrequired
titlestringrequired
statusintegerrequired
min -9007199254740991 · max 9007199254740991
detailstringrequired
codestringrequired
request_idstringrequired
issuesobject[]
Show properties
Array of object
pathstringrequired
messagestringrequired
503

The service is temporarily unavailable.

typestringrequired
titlestringrequired
statusintegerrequired
min -9007199254740991 · max 9007199254740991
detailstringrequired
codestringrequired
request_idstringrequired
issuesobject[]
Show properties
Array of object
pathstringrequired
messagestringrequired
Request
import AIInbx from "aiinbx"

const aiinbx = new AIInbx()

const response = await aiinbx.domains.update(
  "dom_0192a3b4c5d67890abcdef1234567890",
  { track_opens: true, track_clicks: true }
)
Response
{
  "id": "string",
  "name": "string",
  "region": "eu-central-1",
  "space_id": "string",
  "parent_id": "string",
  "provided": true,
  "verified_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "tracking": {
    "opens": true,
    "clicks": true
  },
  "records": [
    {
      "purpose": "SPF",
      "type": "MX",
      "name": "string",
      "value": "string",
      "ttl": 0,
      "state": "pending",
      "last_checked_at": "2019-08-24T14:15:22Z"
    }
  ]
}