Edit Cookies

Use this API to edit existing cookies.

Request body

cookieIdstring uuid required

The unique identifier of the cookie.

cookieNamestring

The name of the cookie.

lifespan'SESSION' | 'PERSISTENT'

The duration for which the cookie remains active before expiring.

hoststring

The domain or website that created the cookie.

descriptionstring

The description of the cookie and its intended purpose.

thirdPartyDescriptionstring

The description of third-party cookies and their usage.

lengthinteger

Length of the Cookie lifespan, enter a number greater than 0 if this is a Persistent cookie, otherwise leave as 0

durationTypeinteger

The type of duration indicating whether the cookie is session-based or persistent.

customCategoryNamestring

The custom name assigned to the cookie category.

domainToDeleteIdsstring[]

The list of domain identifiers to be removed from the system.

Example request

[
  {
    "cookieId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "cookieName": "newCookieName123",
    "lifespan": "SESSION",
    "host": "host.com",
    "description": "this cookies is used for functional purposes only",
    "thirdPartyDescription": "this cookies is used for targeting purposes only",
    "length": 5,
    "durationType": 7,
    "customCategoryName": "C0001",
    "domainToDeleteIds": [
      "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "a1234567-b4b5-4042-8cb9-b78038cc4c47"
    ],
    "domainCookieCategoryList": [
      {
        "domainId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
        "customCategoryName": "C0001"
      }
    ],
    "domainCookieSource": [
      {
        "domainId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
        "domainCookieSourceRequestDtoList": []
      }
    ],
    "domainCookieSourceToDelete": [
      {
        "domainId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
        "sourceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      }
    ],
    "descriptionTranslations": [
      {
        "language": "fr",
        "description": "Ce cookie est utilisé à des fins fonctionnelles uniquement"
      }
    ]
  }
]

Response

OK

entityIdstring uuid

The unique identifier of the entity.

entityType'SCAN' | 'DOMAIN' | 'COOKIE'

The type of entity such as cookie, tag, page, form, service, or storage.

The action that was performed or is to be performed.

messagestring

The message or notification text.

contentobject

The main content or data payload of the response.

successboolean

This flag indicates whether the operation completed successfully.

Example response

[
  {
    "entityId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "entityType": "SCAN",
    "action": "ARCHIVE",
    "message": "Scan queued for archival"
  }
]

v1

Edit Cookies

Request body

Example request

Response

Example response