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

channel

string

enum

required

A channel of communication

Allowed:

address

string

required

Address for communications sent on this channel.

consent

boolean

required

Value indicating whether the consumer approves or disapproves of communication

reason

string

required

Free form text value indicating an arbitrary comment about this record

expires

string

ISO8601 formatted date and time

senderAddress

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.

200Consent updated to the following groups. Any groups that are unable to be updated are listed as well