Verify consent and increment frequency counter

Verifies a given consumer has given consent and increments contact frequency count by one. 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

Body Params

Object defining an individual consumer belonging to the specified group.

string
required

The transaction ID generated on the calling service.

string

An arbitrary ID.

string
enum
required

A channel of communication

Allowed:
string
required

Address for communications sent on this channel.

boolean

true indicates that the consent record should be validated against the consent group.

boolean

true indicates that the verification frequency limit should be checked against this consumer.

Responses

400

The 400 Http status encompases all responses that indicate a consumer should NOT be contacted. There
are various responses available based on the different states of consent, frequency, and request params.

The following are the application specific response codes:

codeDescription
20002Recipient has not consented to message
20003Requested consumer was not found in group
20004Unable to reach Contact Policy Service, please try again later
20005Invalid or unknown group ID or channel
20007Frequency cap: Recipient has exceeded frequency cap
20008Frequency cap: The group was not found
20012Consent check failed, customer consent expired
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json