Remove Participant

Beta

DELETE/v1/messaging/conversations/{id}/participants/{pid}

This endpoint is idempotent. Learn more

Removes a participant from a group conversation.

Only an owner or admin can remove someone, participants cannot be removed from a direct message, and callers cannot remove themselves — leave the conversation instead. Use the remove-agent endpoint for agent participants.

The removed member immediately loses access to the conversation, but their earlier messages stay in the thread and a system event records the removal. Adding them back later reactivates the same membership.

Permissions requiredValues:messaging:update

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

idstring

Conversation ID.

pidstring

The participant to remove (its id from the conversation's participants, not the account user's id).

Responses

200

Successful response for Remove Participant

Remove Participant

import OpenMRP from '@openmrp/sdk';

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

const participant = await client.messaging.conversations.participants.delete('cvpt_be2h3ul14cts', {
  id: 'cv_w35z4ck68yq7',
});

console.log(participant);

import OpenMRP from '@openmrp/sdk';

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

const participant = await client.messaging.conversations.participants.delete('cvpt_be2h3ul14cts', {
  id: 'cv_w35z4ck68yq7',
});

console.log(participant);

200 example

{}

{}

Remove Participant

Authorization

Path Parameters

Responses