Opts-out a consent from all groups under specified tenant based on specified rules.

Use this method to update consent details for the specified consumer in all ALLOWLIST groups where the consumer record exists. For DENYLIST groups it adds or updates specified consumer records.

Body Params

Object defining a consumer and the desired consent value

string
required

Destination Id corresponding to the channel.

string
required

Communication channel.

boolean
required
string
required

Free form text value indicating an arbitrary comment about this record

string

ISO8601 formatted date and time

string

The address associated with a group's sender. 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.

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