For the complete documentation index, see llms.txt. This page is also available as Markdown.

Check Email Integration Domain Health

Check email integration domain health.

The Email channel handles transactional and campaign email — templates, footers, signatures, campaigns, and provider integrations.

Handles the email integration domain health.

Check email integration domain health

post
Authorizations
HTTPRequired

JWT Bearer Authorization

Path parameters
versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Body

Check email integration domain health

correlationIdstring · nullableOptional

CorrelationId for each request

cultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

timeZoneIdstring · nullableOptional

TimeZone

envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

projectIdstringRequired

ID of your project. Can be passed in a header as norbix-project-id.

integrationIdstringRequired

The email integration id to check DNS health for. Get it from get_email_integrations.

Responses
200

OK

application/json
domainstring · nullableOptional
post/{version}/notifications/email/integrations/domain-health
POST /{version}/notifications/email/integrations/domain-health HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 120

{
  "correlationId": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "env": "text",
  "projectId": "text",
  "integrationId": "text"
}
200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "domain": "text",
  "items": [
    {}
  ]
}

In the dashboard

Manage this visually in Norbix Cloud — see Notifications.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Check Email Integration Domain Health in the SDK reference, with examples in every language.

Last updated