Tracking technologies

Update a tracking technology

Only the fields you send are changed.

PATCH

/sites/{siteUuidOrDomain}/tracking-technologies/{technologyId}

curl --request PATCH \
  --url https://consent.studio/api/v1/reseller/sites/{siteUuidOrDomain}/tracking-technologies/{technologyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "category": "unclassified",
  "descriptions": {
    "af": "<string>",
    "ar": "<string>",
    "az": "<string>",
    "be": "<string>",
    "bg": "<string>",
    "bs": "<string>",
    "ca": "<string>",
    "ce": "<string>",
    "cs": "<string>",
    "cv": "<string>",
    "cy": "<string>",
    "da": "<string>",
    "de": "<string>",
    "ee": "<string>",
    "el": "<string>",
    "en": "<string>",
    "eo": "<string>",
    "es": "<string>",
    "et": "<string>",
    "ff": "<string>",
    "fi": "<string>",
    "fj": "<string>",
    "fo": "<string>",
    "fr": "<string>",
    "he": "<string>",
    "hr": "<string>",
    "hu": "<string>",
    "hy": "<string>",
    "id": "<string>",
    "it": "<string>",
    "ja": "<string>",
    "ka": "<string>",
    "ko": "<string>",
    "lb": "<string>",
    "lt": "<string>",
    "lv": "<string>",
    "mo": "<string>",
    "mt": "<string>",
    "ne": "<string>",
    "nl": "<string>",
    "no": "<string>",
    "pl": "<string>",
    "pt": "<string>",
    "ro": "<string>",
    "ru": "<string>",
    "rw": "<string>",
    "sa": "<string>",
    "sc": "<string>",
    "sh": "<string>",
    "sk": "<string>",
    "sl": "<string>",
    "sq": "<string>",
    "sr": "<string>",
    "sv": "<string>",
    "ta": "<string>",
    "th": "<string>",
    "tr": "<string>",
    "uk": "<string>",
    "vi": "<string>",
    "zh": "<string>"
  },
  "identifier": "<string>",
  "platform_name": "<string>",
  "privacy_portal_url": "<string>",
  "retention_period": "<string>",
  "synced_fields": [
    "category"
  ],
  "technology_type": "cookie",
  "vendor_name": "<string>"
}
'

{
  "automatically_added": true,
  "category": "<string>",
  "first_found_at": "2023-11-07T05:31:56Z",
  "id": 123,
  "identifier": "<string>",
  "retention_period": "<string>",
  "synced_fields": [
    "<string>"
  ],
  "technology_type": "<string>"
}

Authorizations

Authorizationstringheaderrequired

A reseller API token, issued by Consent Studio support.

Path Parameters

siteUuidOrDomainstringrequired

The UUID or the domain of one of your sites.

technologyIdintegerrequired

The ID of the tracking technology, as returned when listing or creating them.

Body

categoryenum<string>

Available options: unclassified, functional, analytics, marketing

descriptionsobject

Show child attributes

identifierstring

Maximum string length: 255

platform_namestring | null

Maximum string length: 255

privacy_portal_urlstring | null

Maximum string length: 2048

retention_periodstring | null

Maximum string length: 100

synced_fieldsenum<string>[]

technology_typeenum<string>

Available options: cookie, localStorage, sessionStorage, indexedDB, cacheStorage, pixel, serviceWorker

vendor_namestring | null

Maximum string length: 255

Response

Successful response.

automatically_addedbooleanrequired

categorystring | nullrequired

first_found_atstring | nullrequired

idintegerrequired

identifierstringrequired

retention_periodstring | nullrequired

synced_fieldsstring[]required

technology_typestring | enum<string>required

Still need help? Ask the team