API Reference

Remove participants from a WhatsApp group

delete
https://example.com/api/ext/v3/conversations/groups//participants

Removes operators (by email) and/or contacts (by phone/target) from the group.
At least one of operatorEmails or contactTargets must be provided.
Only available on the Business plan.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The group ID to remove participants from.

Body Params

Request body for removing participants from a group.
At least one of OperatorEmails or ContactTargets must be provided.

operator_emails
array of strings | null

Emails of operators to remove from the group.

operator_emails
contact_targets
array of strings | null

Contact phone numbers or targets to remove from the group.
Accepts phone number (e.g. "14155551234"), contactId, or Channel:Phone format.

contact_targets
Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

401

The request is unauthorized.

429

Too many requests. Either the rate limit has been exceeded or usage limits have been reached.

Updated about 5 hours ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 hours ago