19 February

We are working on some important updates related to our Consent 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 {a-date}.
We expect to release these changes into production on approximately the 15 March.

The title and description properties are going to be removed. The default translation will now be stored in the translations property with the other translations. A new default_language property will be added to the Consent model to define the default language returned to an end-user. Also, the description property of a translation will become optional. 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",
  "consent_type": "opt-in"
}
{
  "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"
    },
    de: {
      "title": "Newsletter-Tickets"
    }
  },
  "default_language": "fr",
  "key": "billeterie",
  "consent_type": "opt-in"
}

API impact

All the 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 will 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.

The Management API will be impacted. The expected requests and 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: