Delete Messaging Group

Beta

DELETE/v1/messaging/groups/{id}

This endpoint is idempotent. Learn more

Deletes a reusable roster.

Conversations already started from it are unaffected (their members were snapshotted); they simply lose the roster reference.

Permission requiredValues:messaging:delete

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

idstring

Messaging group ID.

Responses

200

Successful response for Delete Messaging Group

Delete Messaging Group

import OpenMRP from '@openmrp/sdk';

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

const group = await client.messaging.groups.delete('cvgp_wjlypugna7s4');

console.log(group);

import OpenMRP from '@openmrp/sdk';

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

const group = await client.messaging.groups.delete('cvgp_wjlypugna7s4');

console.log(group);

200 example

{}

{}

Delete Messaging Group

Authorization

Path Parameters

Responses