PUT /zones/{zone_id}/settings/zaraz/config

Updates Zaraz configuration for a zone.

Servers

https://api.cloudflare.com/client/v4

Path parameters

Name	Type	Required	Description
`zone_id`	String	Yes

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`historyChange`	Boolean	No	Single Page Application support enabled.
`tools`	Object	Yes	Tools set up under Zaraz configuration, where key is the alpha-numeric tool ID and value is the tool configuration object.
`debugKey`	String	Yes	The key for Zaraz debug mode.
`triggers`	Object	Yes	Triggers set up under Zaraz configuration, where key is the trigger alpha-numeric ID and value is the trigger configuration.
`triggers.name`	Object	No
`triggers.name.name`	String	Yes	Trigger name.
`triggers.name.description`	String	No	Trigger description.
`triggers.name.system`	String	No	Possible values: `"pageload"`
`triggers.name.loadRules[]`	Array	Yes	Rules defining when the trigger is fired.
`triggers.name.excludeRules[]`	Array	Yes	Rules defining when the trigger is not fired.
`consent`	Object	No	Consent management configuration.
`consent.companyStreetAddress`	String	No
`consent.consentModalIntroHTML`	String	No
`consent.hideModal`	Boolean	No
`consent.defaultLanguage`	String	No
`consent.purposes`	Object	No	Object where keys are purpose alpha-numeric IDs
`consent.purposes.name`	Object	No
`consent.purposes.name.name`	String	Yes
`consent.purposes.name.description`	String	Yes
`consent.customCSS`	String	No
`consent.customIntroDisclaimerDismissed`	Boolean	No
`consent.buttonTextTranslations`	Object	No
`consent.buttonTextTranslations.reject_all`	Object	Yes	Object where keys are language codes
`consent.buttonTextTranslations.confirm_my_choices`	Object	Yes	Object where keys are language codes
`consent.buttonTextTranslations.accept_all`	Object	Yes	Object where keys are language codes
`consent.companyName`	String	No
`consent.cookieName`	String	No
`consent.enabled`	Boolean	Yes
`consent.consentModalIntroHTMLWithTranslations`	Object	No	Object where keys are language codes
`consent.purposesWithTranslations`	Object	No	Object where keys are purpose alpha-numeric IDs
`consent.purposesWithTranslations.name`	Object	No
`consent.purposesWithTranslations.name.order`	Integer	Yes
`consent.purposesWithTranslations.name.name`	Object	Yes	Object where keys are language codes
`consent.purposesWithTranslations.name.description`	Object	Yes	Object where keys are language codes
`consent.tcfCompliant`	Boolean	No
`consent.companyEmail`	String	No
`variables`	Object	Yes	Variables set up under Zaraz configuration, where key is the variable alpha-numeric ID and value is the variable configuration. Values of variables of type secret are not included.
`variables.worker`	Object	No
`variables.worker.name`	String	Yes
`variables.worker.type`	String	Yes	Possible values: `"worker"`
`variables.worker.value`	Object	Yes
`variables.worker.value.workerTag`	String	Yes
`variables.worker.value.escapedWorkerName`	String	Yes
`variables.string`	Object	No
`variables.string.name`	String	Yes
`variables.string.type`	String	Yes	Possible values: `"string"`
`variables.string.value`	String	Yes
`variables.secret`	Object	No
`variables.secret.name`	String	Yes
`variables.secret.type`	String	Yes	Possible values: `"secret"`
`variables.secret.value`	String	Yes
`zarazVersion`	Integer	Yes	Zaraz internal version of the config.
`settings`	Object	Yes	General Zaraz settings.
`settings.contextEnricher`	Object	No	Details of the worker that receives and edits Zaraz Context object.
`settings.contextEnricher.workerTag`	String	Yes
`settings.contextEnricher.escapedWorkerName`	String	Yes
`settings.ecommerce`	Boolean	No	Ecommerce API enabled.
`settings.autoInjectScript`	Boolean	Yes	Automatic injection of Zaraz scripts enabled.
`settings.hideUserAgent`	Boolean	No	Removing sensitive data from User Aagent string enabled.
`settings.cookieDomain`	String	No	The domain Zaraz will use for writing and reading its cookies.
`settings.hideExternalReferer`	Boolean	No	Hiding external referrer URL enabled.
`settings.mcRootPath`	String	No	Custom path for Managed Components server functionalities.
`settings.initPath`	String	No	Custom endpoint for Zaraz init script.
`settings.injectIframes`	Boolean	No	Injection of Zaraz scripts into iframes enabled.
`settings.hideQueryParams`	Boolean	No	Removing URL query params enabled.
`settings.scriptPath`	String	No	Custom endpoint for Zaraz main script.
`settings.hideIPAddress`	Boolean	No	Trimming IP address enabled.
`settings.trackPath`	String	No	Custom endpoint for Zaraz tracking requests.
`settings.eventsApiPath`	String	No	Custom endpoint for server-side track events.
`analytics`	Object	No	Cloudflare Monitoring settings.
`analytics.defaultPurpose`	String	No	Consent purpose assigned to Monitoring.
`analytics.sessionExpTime`	Integer	No	Session expiration time (seconds).
`analytics.enabled`	Boolean	No	Whether Advanced Monitoring reports are enabled.
`dataLayer`	Boolean	Yes	Data layer compatibility mode enabled.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.