Categories
Create category
Create a new category for the current account.
POST
/
categories
Create category
curl --request POST \
--url https://cookiechimp.com/api/v1/categories \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"category": {
"name": "Analytics",
"slug": "analytics",
"description": "Cookies that help us understand how the site is used",
"required": false
}
}
'import requests
url = "https://cookiechimp.com/api/v1/categories"
payload = { "category": {
"name": "Analytics",
"slug": "analytics",
"description": "Cookies that help us understand how the site is used",
"required": False
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
category: {
name: 'Analytics',
slug: 'analytics',
description: 'Cookies that help us understand how the site is used',
required: false
}
})
};
fetch('https://cookiechimp.com/api/v1/categories', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cookiechimp.com/api/v1/categories",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'category' => [
'name' => 'Analytics',
'slug' => 'analytics',
'description' => 'Cookies that help us understand how the site is used',
'required' => false
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cookiechimp.com/api/v1/categories"
payload := strings.NewReader("{\n \"category\": {\n \"name\": \"Analytics\",\n \"slug\": \"analytics\",\n \"description\": \"Cookies that help us understand how the site is used\",\n \"required\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://cookiechimp.com/api/v1/categories")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"category\": {\n \"name\": \"Analytics\",\n \"slug\": \"analytics\",\n \"description\": \"Cookies that help us understand how the site is used\",\n \"required\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cookiechimp.com/api/v1/categories")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"category\": {\n \"name\": \"Analytics\",\n \"slug\": \"analytics\",\n \"description\": \"Cookies that help us understand how the site is used\",\n \"required\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "essential",
"name": "Essential",
"description": "Cookies essential for website functionality",
"slug": "essential",
"required": true,
"default_language": "en",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-01-02T00:00:00Z"
}
}{
"errors": [
{
"code": 400,
"message": "Specify account_id when the API key can access more than one account"
}
]
}{
"errors": [
{
"code": 401,
"message": "API key must belong to an account"
}
]
}{
"errors": [
{
"code": 403,
"message": "User must be an admin of this account"
}
]
}{
"errors": [
{
"error": "Name can't be blank"
}
]
}{
"errors": [
{
"code": 429,
"message": "Too many requests. Please retry later."
}
]
}Authorizations
Query Parameters
Which account to act on, as the account's API id. Only meaningful for a user API key, which may reach several accounts — an account key already identifies exactly one and ignores this.
Accepted by the endpoints that declare it; others act on the account the key resolves to on its own.
Optional for reads, where it narrows the request to that account.
Required for writes that declare it when the key can reach more than one
account: without it the request would act on an account it picked rather
than one you named, so it is refused with a 400.
Response
Created category
Was this page helpful?
⌘I
Create category
curl --request POST \
--url https://cookiechimp.com/api/v1/categories \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"category": {
"name": "Analytics",
"slug": "analytics",
"description": "Cookies that help us understand how the site is used",
"required": false
}
}
'import requests
url = "https://cookiechimp.com/api/v1/categories"
payload = { "category": {
"name": "Analytics",
"slug": "analytics",
"description": "Cookies that help us understand how the site is used",
"required": False
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
category: {
name: 'Analytics',
slug: 'analytics',
description: 'Cookies that help us understand how the site is used',
required: false
}
})
};
fetch('https://cookiechimp.com/api/v1/categories', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cookiechimp.com/api/v1/categories",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'category' => [
'name' => 'Analytics',
'slug' => 'analytics',
'description' => 'Cookies that help us understand how the site is used',
'required' => false
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cookiechimp.com/api/v1/categories"
payload := strings.NewReader("{\n \"category\": {\n \"name\": \"Analytics\",\n \"slug\": \"analytics\",\n \"description\": \"Cookies that help us understand how the site is used\",\n \"required\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://cookiechimp.com/api/v1/categories")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"category\": {\n \"name\": \"Analytics\",\n \"slug\": \"analytics\",\n \"description\": \"Cookies that help us understand how the site is used\",\n \"required\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cookiechimp.com/api/v1/categories")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"category\": {\n \"name\": \"Analytics\",\n \"slug\": \"analytics\",\n \"description\": \"Cookies that help us understand how the site is used\",\n \"required\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "essential",
"name": "Essential",
"description": "Cookies essential for website functionality",
"slug": "essential",
"required": true,
"default_language": "en",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-01-02T00:00:00Z"
}
}{
"errors": [
{
"code": 400,
"message": "Specify account_id when the API key can access more than one account"
}
]
}{
"errors": [
{
"code": 401,
"message": "API key must belong to an account"
}
]
}{
"errors": [
{
"code": 403,
"message": "User must be an admin of this account"
}
]
}{
"errors": [
{
"error": "Name can't be blank"
}
]
}{
"errors": [
{
"code": 429,
"message": "Too many requests. Please retry later."
}
]
}