Delete Email Domain

Beta

DELETE/v1/messaging/email-domains/{id}

This endpoint is idempotent. Learn more

Deregisters a domain from the email bridge and removes its sending identity from the mail provider.

Delete the domain's inboxes first: while any inbox still exists on it, this returns a conflict error.

Permission requiredValues:messaging:delete

The role behind your API key or agent must grant this permission.

idstring

Email domain ID.

Responses

200

Successful response for Delete Email Domain

Delete 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.delete('emdom_2rk3omr8vshb');

console.log(emailDomain);

import OpenMRP from '@openmrp/sdk';

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

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

console.log(emailDomain);

200 example

{}

{}

Delete Email Domain

Authorization

Path Parameters

Responses