Platform DocumentationPlatform ChangelogAPI ReferencePush & In-App SDKsSDK Release Notes
API Reference
FAQsWebsite

Delete a consumer from a consent group

delete
https://{your_connecttenant_apidomain }/v1/groups//members

Use this method for deleting a consent record from the specified group. Identify the consumer by address, by alternateAddress (WhatsApp only), or by both; at least one is required. Note- Replace {your_connecttenant_apidomain } in the URL with your hostname to try this API with your environment. See Know your endpoint page.

Path Params
string
required

Unique ID of group

Query Params
string

The specific URL encoded address of the consumer which needs to be deleted. Either address or alternateAddress is required.

string
enum

If specified, will delete consent of the particular channel.

Allowed:
string

WhatsApp-only consumer identifier (BSUID). Requires channel=whatsapp and the WhatsApp BSUID feature flag enabled; must match the configured format, else 400.

Responses

404

Invalid or unknown group ID.

Updated 20 days ago

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

Updated 20 days ago