MailerVerifyProfileDomain¶

POST mailer/providerProfile/verify-domain

Asks the provider about the state of DKIM and SPF for the sender domain of the profile, and stores the answer in domainStatus and domainCheckedAt.

An unverified sender domain is the most common reason "the emails do not arrive", and it is invisible from the sending side: the provider accepts the message and reports it as sent, while mailbox providers drop it into spam. A cron repeats the check on a schedule.

Access Control¶

Allowed role: admin, within the brand of the caller.

Request¶

RESTTCPSDK

POST https://{broker_domain}/mailer/providerProfile/verify-domain

{
  "id": 3
}

{
  "command": "MailerVerifyProfileDomain",
  "extID": "1",
  "data": {
    "id": 3
  }
}

const res = await platform.MailerVerifyProfileDomain({
  id: 3
});

Request Data¶

Field	Type	Required	Description
`id`	int	Yes	Profile id

Behavior¶

Postmark, SendGrid, Mailgun and SES can answer this question; the other adapters honestly return NOT_SUPPORTED so the administrator knows to check the provider panel by hand.
A profile without fromEmail answers UNKNOWN — there is no domain to verify yet.

Response Data¶

Statuses: VERIFIED, UNVERIFIED, NOT_SUPPORTED, UNKNOWN. UNVERIFIED with details is the actionable case — the details say which record is missing.

{
  "profileId": 3,
  "status": "VERIFIED",
  "domain": "brand.example",
  "details": {
    "dkim": { "verified": true },
    "spf": { "verified": true },
    "returnPath": "pm-bounces.brand.example"
  }
}

Errors¶

Code	Error	Description
`404`	`NOT_FOUND`	Profile not found in the brand
`503`	`PROVIDER_UNAVAILABLE`	The provider did not answer the domain query