> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # UpdateCmpConfig # Package: cookieConsentPolicy # Namespace: CmpConfigService # Method link: https://dev.wix.com/docs/api-reference/business-management/cookie-consent-policy/cmp-config/update-cmp-config.md ## Permission Scopes: Manage CMP Configurations: SCOPE.CMP_CONFIG.MANAGE ## Introduction Updates a CMP config. --- ## REST API ### Schema ``` Method: updateCmpConfig Description: Updates a CMP config. URL: https://www.wixapis.com/v2/cmp-configs Method: PATCH # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: cmpConfig, cmpConfig.revision Method parameters: param name: cmpConfig | type: CmpConfig | description: A CMP Config is a collection of settings and parameters defined within a consent management platform. Currently only contains a toggle to manage the visibility of social components until site visitors provide their consent. | required: true - name: revision | type: string | description: Revision number, which increments by 1 each time the CMP config is updated. To prevent conflicting changes, the current revision must be passed when updating the CMP config. | required: true - name: socialElementsBlocked | type: boolean | description: Whether elements are blocked until consent is given. Return type: UpdateCmpConfigResponse - name: cmpConfig | type: CmpConfig | description: Updated CMP config. - name: revision | type: string | description: Revision number, which increments by 1 each time the CMP config is updated. To prevent conflicting changes, the current revision must be passed when updating the CMP config. - name: createdDate | type: string | description: Date and time the CMP config was created. - name: updatedDate | type: string | description: Date and time the CMP config was last updated. - name: socialElementsBlocked | type: boolean | description: Whether elements are blocked until consent is given. Possible Errors: HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: NO_HTML_WEB_APPLICATION_FOUND | Description: Site not found. ``` ### Examples ### Update CmpConfig ```curl curl -X PATCH \ 'https://www.wixapis.com/consent/cmp/v2/cmp-configs' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ --data-binary '{ "cmp_config": { "revision": "2", "social_elements_blocked": true }, "field_mask": { "paths": [ "socialElementsBlocked" ] } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.cookieConsentPolicy.CmpConfigService.updateCmpConfig(cmpConfig) Description: Updates a CMP config. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: cmpConfig, cmpConfig.revision Method parameters: param name: cmpConfig | type: CmpConfig | description: A CMP Config is a collection of settings and parameters defined within a consent management platform. Currently only contains a toggle to manage the visibility of social components until site visitors provide their consent. | required: true - name: revision | type: string | description: Revision number, which increments by 1 each time the CMP config is updated. To prevent conflicting changes, the current revision must be passed when updating the CMP config. | required: true - name: socialElementsBlocked | type: boolean | description: Whether elements are blocked until consent is given. Return type: PROMISE - name: revision | type: string | description: Revision number, which increments by 1 each time the CMP config is updated. To prevent conflicting changes, the current revision must be passed when updating the CMP config. - name: _createdDate | type: Date | description: Date and time the CMP config was created. - name: _updatedDate | type: Date | description: Date and time the CMP config was last updated. - name: socialElementsBlocked | type: boolean | description: Whether elements are blocked until consent is given. Possible Errors: HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: NO_HTML_WEB_APPLICATION_FOUND | Description: Site not found. ``` ### Examples ### updateCmpConfig ```javascript import { cmp } from '@wix/consent-policy'; async function updateCmpConfig(cmpConfig) { const response = await cmp.updateCmpConfig(cmpConfig); }; ``` ### updateCmpConfig (with elevated permissions) ```javascript import { cmp } from '@wix/consent-policy'; import { auth } from '@wix/essentials'; async function myUpdateCmpConfigMethod(cmpConfig) { const elevatedUpdateCmpConfig = auth.elevate(cmp.updateCmpConfig); const response = await elevatedUpdateCmpConfig(cmpConfig); } ``` ### updateCmpConfig (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { cmp } from '@wix/consent-policy'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { cmp }, // Include the auth strategy and host as relevant }); async function updateCmpConfig(cmpConfig) { const response = await myWixClient.cmp.updateCmpConfig(cmpConfig); }; ``` ---