Web application configuration API - PUT data privacy of a web application

Updates data privacy parameters of the specified web application.

This API only supports rule-based web applications. Mobile apps, agentless applications, browser extensions, etc. are not supported.

The request consumes and produces an application/json payload.

PUT	Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/applications/web/{id}/dataPrivacy SaaS https://{your-environment-id}.live.dexp.ae/api/config/v1/applications/web/{id}/dataPrivacy

Authentication

To execute this request, you need the Change data privacy settings permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Parameters

Parameter	Type	Description	In	Required
id	string	The ID of the web application, where you want to update data privacy settings.	path	required
body	ApplicationDataPrivacy	JSON body of the request, containing new data privacy settings.	body	optional

Request parameters JSON model

The ApplicationDataPrivacy object

Data privacy settings of the application.

Element	Type	Description	Required
metadata	ConfigurationMetadata	Metadata useful for debugging.	optional
identifier	string	DESK entity ID of the web application.	optional
dataCaptureOptInEnabled	boolean	Set to `true` to disable data capture and cookies until JavaScriptAPI dtrum.enable() is called.	required
persistentCookieForUserTracking	boolean	Set to `true` to set persistent cookie in order to recognize returning devices.	required
doNotTrackBehaviour	string	How to handle browsers' "Do Not Track": `IGNORE_DO_NOT_TRACK`, or `CAPTURE_ANONYMIZED`, or `DO_NOT_CAPTURE`. The doNotTrackBehaviour element can hold these values.	required

The ConfigurationMetadata object

Metadata useful for debugging

Element	Type	Description	Required
configurationVersions	integer[]	A Sorted list of the version numbers of the configuration.	optional
clusterVersion	string	DESK server version.	optional

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.

      
  {
  "metadata": {
    "configurationVersions": [
      "integer"
    ],
    "clusterVersion": "string"
  },
  "identifier": "string",
  "dataCaptureOptInEnabled": true,
  "persistentCookieForUserTracking": true,
  "doNotTrackBehaviour": "CAPTURE_ANONYMIZED"
}

Possible values

Possible values for the doNotTrackBehaviour element in the ApplicationDataPrivacy object:

CAPTURE_ANONYMIZED
DO_NOT_CAPTURE
IGNORE_DO_NOT_TRACK

Response format

A successful request doesn't return any content.

Response codes

Code	Description
204	Success. Data privacy settings have been updated. Response doesn't have a body.
400	Failed. The input is invalid.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes and produces an application/json payload.

POST	Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/applications/web/{id}/dataPrivacy/validator SaaS https://{your-environment-id}.live.dexp.ae/api/config/v1/applications/web/{id}/dataPrivacy/validator

Authentication

To execute this request, you need the Change data privacy settings permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Response codes

Code	Description
204	Validated. The submitted configuration is valid. Response does not have a body.
400	Failed. The input is invalid.