Delete Email Inbox

Beta

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

This endpoint is idempotent. Learn more

Removes an email inbox.

Mail sent to its address is no longer routed. Conversations the inbox already opened are kept, but replies can no longer be sent on them, so disable the inbox instead of deleting it if you still need to answer open threads.

Permissions requiredValues:messaging:delete

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

idstring

Email inbox ID.

Responses

200

Successful response for Delete Email Inbox

Delete Email Inbox

import OpenMRP from '@openmrp/sdk';

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

const emailInbox = await client.messaging.emailInboxes.delete('eminb_2s9kobr9s7tp');

console.log(emailInbox);

import OpenMRP from '@openmrp/sdk';

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

const emailInbox = await client.messaging.emailInboxes.delete('eminb_2s9kobr9s7tp');

console.log(emailInbox);

200 example

{}

{}

Delete Email Inbox

Authorization

Path Parameters

Responses