Consents Model updates

Released on 02 June

We are working on some important updates related to our Consents Model. It is important that you are aware of this change in case you need to accommodate your system.

timeline

This announcement was made on the 20 May.
We expect to release these changes into production on approximately the 02 June.

Check out the tabs below to get a visual of the changes:

  • Current Consent Model

  • New Consent Model

{
  "translations": [
    {
      "lang_code": "en",
      "description": "Tickets newsletter (on-sale dates, special offers).",
      "title": "Tickets newsletter"
    },
    {
      "lang_code": "es",
      "description": "Entradas newsletter (fechas de venta, ofertas esclusivas).",
      "title": "Newsletter entradas"
    }
  ],
  "description": "La newsletter billeterie (date d'ouvertures des ventes matchs, offres exclusives).",
  "title": "Newsletter billeterie",
  "key": "billeterie",
  "tags": ["web", "weekly"],
  "consent_type": "opt-in"
}
{
    "versions": [
        {
            "version_id": 2,
            "author_name": "auser@mailbox.com",
            "translations": {
                "fr": {
                    "title": "Newsletter billeterie",
                    "description": "La newsletter billeterie (date d'ouvertures des ventes matchs, offres exclusives)."
                },
                "en": {
                    "description": "Tickets newsletter (on-sale dates, special offers).",
                    "title": "Tickets newsletter"
                },
                "es": {
                    "description": "Entradas newsletter (fechas de venta, ofertas esclusivas).",
                    "title": "Newsletter entradas"
                }
            }
        },
        {
            "version_id": 1,
            "author_name": "auser@mailbox.com",
            "translations": {
                "fr": {
                    "title": "Newsletter billeterie",
                    "description": "La newsletter billeterie."
                }
            }
        }
    ],
  "key": "billeterie",
  "tags": ["web", "weekly"],
  "consent_type": "opt-in",
  "status": "active"
}

Migration

All existing consents will be migrated to the new model.

We will use your ReachFive account’s Country code (defined in the Settings section on the ReachFive Console) as the default locale of your existing consent’s title and description.

If there is no country code defined, we set the default locale to French (fr). If a translation in this new default language already exists, we will keep the existing translation over the deprecated title and description.
Please check that your country code locale or fr is not already defined as a translation if you want to keep the values of the existing title and description.

API impact

Consents can be managed by the Management API (see the Consents section). The expected responses will now change to reflect the latest development.

An empty value is not returned by the API if the property is optional. For example, the description of a translation will not be returned if no value was set.
Affected endpoints

The Delete consent endpoint was replaced by the new Update a consent’s a status endpoint.

You can no longer delete consents, but you can archive them.