---
title: "Edit Cookies"
method: PUT
path: "/api/cmp/v1/webscans/cookies"
tags: ["Cookies"]
---

# Edit Cookies

`PUT /api/cmp/v1/webscans/cookies`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/cmp/v1/webscans/cookies`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `COOKIE`

Use this API to edit existing cookies.

## Request body

- CookieUpdateRequestDto[]
  - `cookieId` string, uuid, required: The unique identifier of the cookie.
  - `cookieName` string: The name of the cookie.
  - `lifespan` 'SESSION' | 'PERSISTENT': The duration for which the cookie remains active before expiring.
  - `host` string: The domain or website that created the cookie.
  - `description` string: The description of the cookie and its intended purpose.
  - `thirdPartyDescription` string: The description of third-party cookies and their usage.
  - `length` integer: Length of the Cookie lifespan, enter a number greater than 0 if this is a Persistent cookie, otherwise leave as 0
  - `durationType` integer: The type of duration indicating whether the cookie is session-based or persistent.
  - `customCategoryName` string: The custom name assigned to the cookie category.
  - `domainToDeleteIds` string[]: The list of domain identifiers to be removed from the system.
  - `domainCookieCategoryList` DomainCookieCategoryRequestDto[]: The list of categories assigned to cookies for the specific domain.
    - `domainId` string, uuid: The unique identifier of the domain.
    - `customCategoryName` string: The custom name assigned to the cookie category.
    - `thirdParty` boolean: This flag indicates whether the cookie originates from a third-party source.
    - `description` string: The description of the cookie and its intended purpose.
  - `domainCookieSource` CookieSourceRequestDto[]: The source from which domain cookies originate.
    - `domainId` string, uuid: The unique identifier of the domain.
    - `domainCookieSourceRequestDtoList` DomainCookieSourceRequestDto[]: The list of cookie source configuration requests for the domain.
      - `resourceType` 'MANUAL' | 'PATTERN' | 'SCRIPT' | 'MAIN_FRAME': The type of web resource such as script, image, or stylesheet.
      - `resourceOrigin` 'SCANNER' | 'MANUAL' | 'TELEMETRYSCANNER': resource origin type
      - `resourceMatchType` 'URL' | 'SYSTEM_PATTERN' | 'CUSTOM_PATTERN': resource match type
      - `trackerType` string: The category of tracking technology being used.
      - `id` string, uuid: The unique identifier of the item.
      - `ResourceUrl` string: The web address where the resource is located.
  - `domainCookieSourceToDelete` DomainCookieSourceRequestDto[]: The cookie sources that are marked for deletion.
    - `resourceType` 'MANUAL' | 'PATTERN' | 'SCRIPT' | 'MAIN_FRAME': The type of web resource such as script, image, or stylesheet.
    - `resourceOrigin` 'SCANNER' | 'MANUAL' | 'TELEMETRYSCANNER': resource origin type
    - `resourceMatchType` 'URL' | 'SYSTEM_PATTERN' | 'CUSTOM_PATTERN': resource match type
    - `trackerType` string: The category of tracking technology being used.
    - `id` string, uuid: The unique identifier of the item.
    - `ResourceUrl` string: The web address where the resource is located.
  - `descriptionTranslations` DescriptionTranslationDto[]: The translations of descriptions provided in different languages.
    - `langCode` string: The language code used for localization purposes.
    - `defaultDescription` string: The standard description that is used when no translation is provided for a specific language.
    - `thirdPartyDescription` string: The description of third-party cookies and their usage.

## Response `200`

OK

- EntityActionResponseDto[]
  - `entityId` string, uuid: The unique identifier of the entity.
  - `entityType` 'SCAN' | 'DOMAIN' | 'COOKIE': The type of entity such as cookie, tag, page, form, service, or storage.
  - `action` 'ARCHIVE' | 'SCHEDULE' | 'SCHEDULE_CANCEL' | 'EDIT' | 'CREATE' | 'DELETE': The action that was performed or is to be performed.
  - `message` string: The message or notification text.
  - `content` object: The main content or data payload of the response.
  - `success` boolean: This flag indicates whether the operation completed successfully.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500`: Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/consent-preferences-cookie-consent.md) - [All operations](https://skmtc.dev/onetrust/apis/consent-preferences-cookie-consent/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/consent-preferences-cookie-consent/revisions/b4fb4606f973?raw)