API
Configurations
A notice configuration determines the full behavior of a consent notice, including the platform that it applies to, its targeted properties, and all the configuration options for the notice (texts, buttons, etc.).
For a given notice, the full history of configurations are kept:
- The current draft configuration that is not yet applied to the notice and can be modified to prepare for future publishing.
- The previous published configurations that are kept for audit and compliance purposes and cannot be modified.
The
/widgets/notices/configs endpoint of the API exposes the notice configurations managed by Didomi for your organizations. For a full reference of the endpoint and the resources that it returns, visit https://api.didomi.io/docs/.Draft configuration
The notice configuration that can be modified before publishing is called "draft" and is the notice configuration that is not yet deployed. If you want to modify the configuration of your notice on your websites/apps, you must first modify the draft configuration and then publish it.
Get the current draft configuration for a notice
The current draft configuration for a notice is marked with
null as the value for its deployed_at field.To identify the current draft configuration, get all the notice configurations and find the one that has
deployed_at = null.Example
1
GET https://api.didomi.io/v1/widgets/notices/configs?organization_id=<Organization ID>¬ice_id=<Notice ID>
2
3
{
4
"total": 2,
5
"limit": 100,
6
"skip": 0,
7
"data": [
8
{
9
"deployed_at": "2020-09-01T21:26:50.629Z",
10
"custom_json": { ... },
11
"config": { ... },
12
"default": false,
13
"platform": "web",
14
"targets": [],
15
"text_mode": "approved",
16
"text_id": "W37f3Bmd",
17
"full_atp": false,
18
"enable_ignore_consent_before": false,
19
"ignore_consent_before": null,
20
"negative_action": null,
21
"disagree_button_style": "secondary",
22
"country": null,
23
"notice_deny_applies_to_li": false,
24
"preferences_deny_applies_to_li": true,
25
"consent_duration": 12,
26
"consent_duration_unit": "months",
27
"notice_id": "GG2rdGfN",
28
"organization_id": "didomi",
29
"id": "tiYx2MWn",
30
"created_at": "2020-07-23T09:14:26.264Z",
31
"updated_at": "2020-09-01T21:26:50.701Z",
32
"version": 0
33
},
34
{
35
"deployed_at": null,
36
"custom_json": { ... },
37
"config": { ... },
38
"default": false,
39
"platform": "web",
40
"targets": [
41
"some.domain.test.exmpl"
42
],
43
"text_mode": "approved",
44
"text_id": "W37f3Bmd",
45
"full_atp": false,
46
"enable_ignore_consent_before": false,
47
"ignore_consent_before": null,
48
"negative_action": null,
49
"disagree_button_style": "secondary",
50
"country": null,
51
"notice_deny_applies_to_li": false,
52
"preferences_deny_applies_to_li": true,
53
"consent_duration": 12,
54
"consent_duration_unit": "months",
55
"notice_id": "GG2rdGfN",
56
"organization_id": "didomi",
57
"id": "2fcjz7Cw",
58
"created_at": "2020-09-01T21:26:50.724Z",
59
"updated_at": "2021-03-24T15:56:50.461Z",
60
"version": 0
61
}
62
]
63
}
Copied!
In this example, the second configuration (with ID
2fcjz7Cw) is the current draft and can be modified to prepare for publishing.Modify the draft configuration
To update the configuration of your consent notice, you must update the draft configuration and then publish it. To update the draft configuration send a
PATCH request to the current draft configuration.Example
To modify the draft configuration, send a
PATCH request with an updated configuration. Example for switching the notice to a mobile notice with a consent duration of 6 months:1
PATCH https://api.didomi.io/v1/widgets/notices/configs/7bKP4CRr
2
3
{
4
"platform": "app",
5
"consent_duration": 6,
6
"consent_duration_unit": "months"
7
}
Copied!
What is the config field?
The full configuration of a notice is split between the
config field and the other fields on the configuration object:- The
configfield follows the format documented for the configuration of the SDKs in our SDKs configuration section.
Didomi is in the process of transforming the
config field into separate fields on configurations and will do so in a backward-compatible manner. The config field will eventually be deprecated as it proved complex to work with.Published configurations
Configurations that are already published (or "deployed") are marked with their publishing date in the
deployed_at field. A configuration that is already published cannot be modified so that it can be used as proof of how consent was collected at a given time.Publish a draft configuration
Only draft configurations can be published. A draft configuration is marked as deployed once it is published and cannot be published or modified anymore.
To publish the current draft configuration, create a deployment for that configuration by sending a
POST /widgets/notices/deployments request for that specific configuration.After a configuration is published, the publishing date is set in its
deployed_at field and that configuration cannot be modified or published anymore. A new draft configuration is automatically created for the notice as a copy of the latest published configuration. To make further changes to the notice configuration, get the new draft configuration and modify it.Example
1
POST https://api.didomi.io/v1/widgets/notices/deployments
2
3
BODY
4
{
5
"notice_id": "GG2rdGfN",
6
"organization_id": "didomi",
7
"production_config_id": "2fcjz7Cw",
8
"message": "Description of changes included in my deployment"
9
}
Copied!
The
production_config_id should be the ID of the draft config you are publishing. message is a text field that can be used to indicate information on what changes are included in your deployment.Last modified 1yr ago