Consent logs

{
  "consent_key": "all-the-things",
  "consent_title": "all the things",
  "consent_type": "opt-out",
  "consent_version": {
    "language": "fr",
    "version_id": 1
  },
  "date": "2021-10-25T13:34:54.000Z",
  "granted": false,
  "id": "AXy3qUft…​AqIjInslG",
  "is_group": false,
  "source": {
    "canal": "job",
    "id": "AXy3q…​qIjInslF",
    "name": "update user consents"
  },
  "user_id": "AXy3qR..IjInsk9"
}
Name Description

consent_key

The consent key.

Uniquely identifies a Consent. This key is used to reference the Consent in the ReachFive SDK or API.

consent_title

The consent title.

This is what the user reads to decide to opt-in or opt-out.

consent_type

Specifies the Consent type.

  • opt-in: requires an explicit action by the user on signup.

  • opt-out: is automatically accepted on user signup. If a user does not want to accept the given processing purpose, the user must explicitly opt out of it.

consent_version

The version of the consent.

Consent versions allow you to offer different versions of a single Consent. For example, if you need to what is accepted in the Consent, but the Consent is standard across your offerings, creating a new Consent version allows you to manage this from one place in the ReachFive Console.

When creating a Consent, Version 1 is automatically available to you where you (at a minimum) add the translation for your default account language.

date

The date the consent log was created.

granted

A boolean specifying the consent was granted or not.

id

The unique ID for the specific consent log.

is_group

A boolean that specifies if this particular consent is part of a larger consent group.

source

An object that contains information regarding the source of the consent log.

This includes the

  • channel (such as a job that was run)

  • the id of the source channel (such as a job ID)

  • the name of the source

user_id

The ID of the user that exported the consent log.