Skip to content

Data retention period

A data retention period refers to the amount of time that an organization holds onto data before it's disposed of or archived. It's crucial to meet certain legal, regulatory, and business requirements for data retention.

The feature enables configuration of a time frame during which the data will be considered valid on a widget level.

There are two options for managing expired data: * remove it completely from data storage * mark it as “expired” so it will be still available for end users and customers via standard interfaces for update or further conditional processing

Retention period setup on a widget level

In order to set up a retention period, open the widget detail configuration modal and set up a number of months for the validity period in the Retention Period field. The update to this parameter will not affect already captured preferences, and will be applied only for new submissions or updates to the existing ones.

You can also specify how the preference data should be treated after it is expired. For example, if it should be kept in the system for user to make a decision to update or to delete it, or if it should be deleted from the system automatically.

Setting up a Retention Period
Setting up a Retention Period

Expired preference data

If the preference data object was not updated during the retention period, data is considered as expired. If the widget was configured to keep expired data, it will still be available for both customers and end users.

Admin Interface

Preference data object is marked with EXPIRED label and EXPIRATION event is added into the History Log
Preference data object is marked with EXPIRED label and EXPIRATION event is added into the History Log

Public API output

[
  {
    "uuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
    "widgetId": "1234abcd-22bb-33cc-44dd-12345678abcd",
    "pending": false,
    "answers": [
      {
        "topicUuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
        "topicAnswerUuids": [
          "1234abcd-22bb-33cc-44dd-12345678abcd",
          "1234abcd-22bb-33cc-44dd-12345678abcd",
          "1234abcd-22bb-33cc-44dd-12345678abcd"
        ]
      }
    ],
    "createdAt": "2024-01-01T07:36:43.375Z",
    "updatedAt": "2024-05-12T07:36:43.375Z",
    "expiresAt": "2024-06-12T07:40:43.331Z"
  }
]
expiresAt element of preference data object represents current expiration date.

End user - facing Embedded widget

If preferences have expired, the widget will show a corresponding warning message and the user will be asked to chose to confirm the current preferences selection or remove them completely.

Embedded widget shows expired preferences
Embedded widget shows expired preferences