Didomi icon

Didomi

Use the Didomi API

Actions75

Data Manager → Add Purpose Into Your Configuration Tree

AI-generated

Overview

This node operation adds a purpose into a specified configuration tree within the Didomi platform. It is useful for managing and organizing purposes related to user data and privacy preferences in a centralized configuration tree. For example, a user can add a new purpose to a configuration tree to update or customize privacy settings for their organization.

Use Case Examples

  1. Adding a new purpose to a configuration tree to reflect updated privacy regulations.
  2. Organizing purposes in a configuration tree for better management of user consent preferences.

Properties

Name Meaning
Configuration Tree ID The unique identifier of the configuration tree where the purpose will be added. This is required to specify the target configuration tree.
Query Parameters Optional parameters to customize the API request, such as filtering or pagination options.
Request Body The JSON body of the request containing the purpose data to be added into the configuration tree.

Output

JSON

  • response - The JSON response from the Didomi API after adding the purpose into the configuration tree. It typically contains details of the added purpose or confirmation of the operation.

Dependencies

  • Didomi API key and secret credentials are required for authentication.

Troubleshooting

  • Missing Configuration Tree ID will cause an error as it is required to specify where to add the purpose.
  • Invalid or missing API credentials will prevent authentication and cause the operation to fail.
  • Malformed JSON in the request body can cause the API request to fail.
  • Network or API endpoint issues can cause request failures; ensure the Didomi API is reachable.

Links

  • Didomi API Documentation - Official documentation for the Didomi API, useful for understanding request and response formats.

Discussion