myOneTrustDeveloper ForumTechnology Partners
API Reference
Subscribe via RSS
Start typing to search…

Update Cookie

put
https://customer-my-onetrust-com.ezproxy.utas.edu.au/api/cookiemanager/v1/cookies

Use this API to update an existing cookie.

🗒

Things to Know

  • There are two types of IDs for cookies: Cookie ID and Domain Cookie ID. The Cookies Results All Domains export can be downloaded from the Categorizations screen in the OneTrust application to select the ID for the cookieId parameter.
  • For manually created cookies, only cookieName, lifespan, an host will be updated.
  • Values must be passed in all the parameters within descriptionTranslations for a cookie translation to be updated.
Body Params
string
required

ID of the cookie. This value is obtained from Create Cookie API.

string

Name of the cookie.

string
enum

Lifespan of the cookie.

Allowed:
string

Host of the cookie.

string
Defaults to ""

Description of the cookie. or less

string
Defaults to ""

Short text describing the host’s purpose or description of the cookie. It should be 1075 characters or less.

string

Unique identifier of a cookie category (Cookie Category ID).

integer
Defaults to 0

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

integer
enum

Unit of time for the cookie lifespan, enter 1 (for days), 7 (for weeks), 30 (for months), or 365 (for years) based on the time unit the cookie lifespan is measured in.

Allowed:
domainCookieCategoryList
array of objects
Defaults to

A list of domain level categorizations for the cookie.

domainCookieCategoryList
domainToDeleteIds
array of strings
Defaults to

A list of domain IDs to be unassigned from cookie.

domainToDeleteIds
domainCookieSource
array of objects

Domain Cookie Source to be added.

domainCookieSource
domainCookieSourceToDelete
array of objects

Domain Cookie Source to be removed.

domainCookieSourceToDelete
descriptionTranslations
array of objects

Description translations

descriptionTranslations
Responses

400

Bad Request.

Possible reason: Invalid cookieid, please check if cookieId passed is correct.

401

Unauthorized.

403

Forbidden.

Possible reasons:
You do not have enough permissions to invoke this endpoint.

404

Not Found.

409

Updated 4 months ago

Language
Credentials
OAuth2
Missing 1 required scope
Response 
 Choose an example:
application/json
*/*
Updated 4 months ago