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

Opt-out a consumer from all groups.

post
https://{your_connecttenant_apidomain }/v1/groups/*/members/optOut

Use this method to Opt-out a consumer from all groups under a specified tenant. For DENYLIST groups- Opt-out is applied to all groups, regardless of channel match. For ALLOWLIST groups- Opt-out is applied only to groups where the sender address matches. Note- Replace {your_connecttenant_apidomain } in the URL with your hostname to try this API with your environment. See Know your endpoint page.

Body Params

Object defining a consumer and the desired consent value

Consumer identity and the desired consent value. For channel=whatsapp either address or alternateAddress is required (both may be supplied, and alternateAddress / replaceAlternateAddress apply to WhatsApp only); for all other channels address is required and alternateAddress is not applicable.

string
enum
required

A channel of communication

Allowed:
string

Address for communications sent on this channel.

boolean
required

Value indicating whether the consumer approves or disapproves of communication

string
required

Free form text value indicating an arbitrary comment about this record

string

ISO8601 formatted date and time

string

WhatsApp-only consumer identifier (BSUID). Valid only for channel=whatsapp and only accepted when the WhatsApp BSUID feature flag is enabled; must match the configured BSUID format. Requests violating these rules return 400.

boolean
Defaults to false

WhatsApp-only overwrite flag. When true, the supplied alternateAddress overwrites the existing alternateAddress on the consent record. Requires channel=whatsapp and a non-empty alternateAddress; the API returns 400 otherwise. Ignored when the WhatsApp BSUID feature flag is disabled. Write-only: accepted on requests but never emitted in responses.

string

The address associated with a group's sender. Used to filter groups for opt-out. If specified, the consent change request will only apply to all groups that contains a sender's address matching this value.

metadata
object

Optional fields to store extra data along with the consent change request

Responses

404

No groups found for the provided tenant 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