POST
/
cookies
curl --request POST \
  --url https://cookiechimp.com/api/v1/cookies \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "company_name": "<string>",
  "domain": "<string>",
  "duration": "<string>",
  "partitioned": true,
  "path": "<string>",
  "same_site": "<string>",
  "cookie_category_id": "<string>"
}'
{
  "company_name": "Example Company Name",
  "description": "Tracks user preferences.",
  "domain": "www.example.com",
  "duration": "1 year",
  "last_seen_at": "2023-03-23T12:34:56Z",
  "name": "user-pref-cookie",
  "partitioned": false,
  "path": "/",
  "same_site": "Lax",
  "cookie_category_id": "cat1",
  "status": "finalised",
  "approved_by_type": "AI",
  "wildcard_cookie_id": null,
  "id": "user-pref-cookie",
  "is_wildcard_cookie": false
}

Authorizations

X-API-KEY
string
headerrequired

Body

application/json
name
string
required

Name of the cookie

description
string

Description of the cookie that is displayed to users

company_name
string

Name of the company that owns the cookie

domain
string

Domain of the cookie

duration
string

Duration of the cookie

partitioned
boolean

Whether the cookie is partitioned

path
string

Path of the cookie

same_site
string

SameSite attribute of the cookie

cookie_category_id
string

ID of the cookie category

Response

201 - application/json
name
string
required

Name of the cookie

description
string

Description of the cookie that is displayed to users

company_name
string

Name of the company that owns the cookie

domain
string

Domain of the cookie

duration
string

Duration of the cookie

partitioned
boolean

Whether the cookie is partitioned

path
string

Path of the cookie

same_site
string

SameSite attribute of the cookie

cookie_category_id
string

ID of the cookie category

id
string

Unique identifier for the cookie

last_seen_at
string
status
enum<string>
default: draft
Available options:
draft,
processing,
in_review,
finalised
approved_by_type
string | null
approved_by_id
string | null
wildcard_cookie_id
string | null
is_wildcard_cookie
boolean