ONonetrust
Cookies

Create Cookie

Use this API to create a new cookie.

post/v1/cookies

Request

  • Base URL
    https://customer.my.onetrust.com/api/cookiemanager
  • URL
    https://customer.my.onetrust.com/api/cookiemanager/v1/cookies
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{$$.env.host}/api/access/v1/oauth/token

Request body

cookieNamestring required

Name of the cookie.

lifespan'PERSISTENT' | 'SESSION' required

Lifespan of the cookie.

hoststring required

Host of the cookie.

descriptionstring

Description of the cookie, It should be 1075 characters or less.

customCategoryNamestring required

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

lengthinteger

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

durationType1 | 7 | 30 | 365 required

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.

Example request

{
  "customCategoryName": "C0001"
}

Response

Created.

idstring

ID of the cookie.

namestring

Name of the cookie.

descriptionstring

Purpose of the cookie.

hoststring

Host of the cookie.

pathstring

Path of the cookie.

sourcestring

The source from which the cookie is created.

cookieLifeSpanstring

Lifespan of the cookie.

httpOnlyboolean

Flag indicating the cookie is Http only or not.

secureboolean

Flag indicating the cookie is secure or not.

lengthinteger

Length of the cookie lifespan.

durationTypeinteger

Unit of time for the cookie lifespan.

Example response

{
  "source": "MANUAL"
}

Changes

No recorded changes to this operation across all 1 revision of this API.