Add or update consent

post

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

Use this method to add or update consent details in the specified group. For channel=whatsapp either address or alternateAddress is required; for all other channels address is required and alternateAddress is not applicable. 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

groupId

string

required

Unique ID of group

Body Params

A consumer and the desired consent value

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

channel

string

enum

required

A channel of communication

Allowed:

address

string

Address for communications sent on this channel. Required for all channels except whatsapp, where it may be omitted provided alternateAddress is supplied.

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

alternateAddress

string

WhatsApp-only consumer identifier (BSUID). When the WhatsApp BSUID feature flag is enabled and channel=whatsapp, address may be omitted provided this alternateAddress is supplied. Rejected with 400 for non-WhatsApp channels or when the feature flag is disabled.

replaceAlternateAddress

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.

metadata

object

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

Responses

204

Consent added or changed

404

Invalid or unknown group ID.

409

Invalid channel type for requested group

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here!