Verify Email Domain

Beta

POST/v1/messaging/email-domains/{id}/actions/verify

Idempotent with Idempotency-Key header. Learn more

Checks whether the domain's DKIM records have been published and marks it verified once they are confirmed.

Call this after publishing the DKIM records returned at registration. It is safe to call repeatedly: a domain whose records are not visible yet is returned unchanged in pending, and an already-verified domain is returned as-is without re-checking. DNS propagation can take a while, so expect to poll.

Permissions requiredValues:messaging:update

The role behind your API key or agent must grant every one of these permissions.

idstring

Email domain ID.

idstring

Email domain ID.

objectstringenumValues:email_domain

Resource type identifier.

domainstring

The fully-qualified domain name (e.g. support.acme.com).

statusstringenumValues:pendingverifiedfailed

Verification status.

pending: registered and awaiting DKIM confirmation.
verified: DKIM confirmed; the domain can send mail.
failed: verification could not be completed.

Inboxes can only be created on a verified domain.

dkim_tokensarray of string

The DKIM tokens that must be published in your DNS before the domain can be verified.

Publish each token as a CNAME record on the domain, then call the verify action to confirm them.

verified_atstring (date-time)nullable

When the domain's DKIM verification was confirmed.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Verify Email Domain

Verify Email Domain

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const emailDomain = await client.messaging.emailDomains.actions.verify('emdom_2rk3omr8vshb');

console.log(emailDomain.id);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const emailDomain = await client.messaging.emailDomains.actions.verify('emdom_2rk3omr8vshb');

console.log(emailDomain.id);

200 example

{
  "id": "emdom_2rk3omr8vshb",
  "object": "email_domain",
  "domain": "support.acme.com",
  "status": "pending",
  "dkim_tokens": [
    "abc123._domainkey.support.acme.com",
    "def456._domainkey.support.acme.com"
  ],
  "verified_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "emdom_2rk3omr8vshb",
  "object": "email_domain",
  "domain": "support.acme.com",
  "status": "pending",
  "dkim_tokens": [
    "abc123._domainkey.support.acme.com",
    "def456._domainkey.support.acme.com"
  ],
  "verified_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Verify Email Domain

Authorization

Path Parameters

Returns

Responses