Consent Banners
Create consent banner
Create a consent banner. It inherits the design of the account’s most recently updated banner, the same way the dashboard’s new-banner flow does, and is always created disabled — enable it once its content and targeting are set. A name is generated if you don’t supply one.
Translations are not accepted here; add them by updating the banner afterwards, which is where the account’s language entitlement is enforced.
POST
/
consent-banners
Create consent banner
curl --request POST \
--url https://cookiechimp.com/api/v1/consent-banners \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"consent_banner": {
"banner_accept_btn_text": "<string>",
"banner_accept_necessary_btn_text": "<string>",
"banner_footer_content": "<string>",
"banner_preferences_btn_text": "<string>",
"btn_border_radius": "<string>",
"consent_additional_description": "<string>",
"consent_button_placement": "<string>",
"consent_description": "<string>",
"consent_duration_days": 123,
"consent_layout": "<string>",
"consent_mode": "<string>",
"consent_position": "<string>",
"consent_title": "<string>",
"dark_mode": "<string>",
"do_not_sell_description": "<string>",
"do_not_sell_title": "<string>",
"enable_banner_footer": true,
"enable_tcf": true,
"equal_weight_buttons": true,
"floating_preferences_icon_position": "<string>",
"force_consent": true,
"language_autodetect": "<string>",
"logo_url_dark": "<string>",
"logo_url_light": "<string>",
"modal_border_radius": "<string>",
"name": "<string>",
"preferences_accept_btn_text": "<string>",
"preferences_accept_necessary_btn_text": "<string>",
"preferences_control_level": "<string>",
"privacy_policy_url": "<string>",
"save_preferences_btn_text": "<string>",
"settings_description": "<string>",
"settings_layout": "<string>",
"settings_more_info": "<string>",
"settings_more_info_title": "<string>",
"settings_position_x": "<string>",
"settings_title": "<string>",
"show_banner_accept_btn": true,
"show_banner_accept_necessary_btn": true,
"show_banner_close_btn": true,
"show_banner_preferences_btn": true,
"show_floating_preferences_icon": true,
"show_preferences_accept_btn": true,
"show_preferences_accept_necessary_btn": true,
"show_save_preferences_btn": true,
"show_services": true,
"swap_buttons": true,
"target_canadian_regions": [
"<string>"
],
"target_countries": [
"<string>"
],
"target_type": "<string>",
"target_us_states": [
"<string>"
],
"button_colors": {}
}
}
'import requests
url = "https://cookiechimp.com/api/v1/consent-banners"
payload = { "consent_banner": {
"banner_accept_btn_text": "<string>",
"banner_accept_necessary_btn_text": "<string>",
"banner_footer_content": "<string>",
"banner_preferences_btn_text": "<string>",
"btn_border_radius": "<string>",
"consent_additional_description": "<string>",
"consent_button_placement": "<string>",
"consent_description": "<string>",
"consent_duration_days": 123,
"consent_layout": "<string>",
"consent_mode": "<string>",
"consent_position": "<string>",
"consent_title": "<string>",
"dark_mode": "<string>",
"do_not_sell_description": "<string>",
"do_not_sell_title": "<string>",
"enable_banner_footer": True,
"enable_tcf": True,
"equal_weight_buttons": True,
"floating_preferences_icon_position": "<string>",
"force_consent": True,
"language_autodetect": "<string>",
"logo_url_dark": "<string>",
"logo_url_light": "<string>",
"modal_border_radius": "<string>",
"name": "<string>",
"preferences_accept_btn_text": "<string>",
"preferences_accept_necessary_btn_text": "<string>",
"preferences_control_level": "<string>",
"privacy_policy_url": "<string>",
"save_preferences_btn_text": "<string>",
"settings_description": "<string>",
"settings_layout": "<string>",
"settings_more_info": "<string>",
"settings_more_info_title": "<string>",
"settings_position_x": "<string>",
"settings_title": "<string>",
"show_banner_accept_btn": True,
"show_banner_accept_necessary_btn": True,
"show_banner_close_btn": True,
"show_banner_preferences_btn": True,
"show_floating_preferences_icon": True,
"show_preferences_accept_btn": True,
"show_preferences_accept_necessary_btn": True,
"show_save_preferences_btn": True,
"show_services": True,
"swap_buttons": True,
"target_canadian_regions": ["<string>"],
"target_countries": ["<string>"],
"target_type": "<string>",
"target_us_states": ["<string>"],
"button_colors": {}
} }
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({
consent_banner: {
banner_accept_btn_text: '<string>',
banner_accept_necessary_btn_text: '<string>',
banner_footer_content: '<string>',
banner_preferences_btn_text: '<string>',
btn_border_radius: '<string>',
consent_additional_description: '<string>',
consent_button_placement: '<string>',
consent_description: '<string>',
consent_duration_days: 123,
consent_layout: '<string>',
consent_mode: '<string>',
consent_position: '<string>',
consent_title: '<string>',
dark_mode: '<string>',
do_not_sell_description: '<string>',
do_not_sell_title: '<string>',
enable_banner_footer: true,
enable_tcf: true,
equal_weight_buttons: true,
floating_preferences_icon_position: '<string>',
force_consent: true,
language_autodetect: '<string>',
logo_url_dark: '<string>',
logo_url_light: '<string>',
modal_border_radius: '<string>',
name: '<string>',
preferences_accept_btn_text: '<string>',
preferences_accept_necessary_btn_text: '<string>',
preferences_control_level: '<string>',
privacy_policy_url: '<string>',
save_preferences_btn_text: '<string>',
settings_description: '<string>',
settings_layout: '<string>',
settings_more_info: '<string>',
settings_more_info_title: '<string>',
settings_position_x: '<string>',
settings_title: '<string>',
show_banner_accept_btn: true,
show_banner_accept_necessary_btn: true,
show_banner_close_btn: true,
show_banner_preferences_btn: true,
show_floating_preferences_icon: true,
show_preferences_accept_btn: true,
show_preferences_accept_necessary_btn: true,
show_save_preferences_btn: true,
show_services: true,
swap_buttons: true,
target_canadian_regions: ['<string>'],
target_countries: ['<string>'],
target_type: '<string>',
target_us_states: ['<string>'],
button_colors: {}
}
})
};
fetch('https://cookiechimp.com/api/v1/consent-banners', 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/consent-banners",
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([
'consent_banner' => [
'banner_accept_btn_text' => '<string>',
'banner_accept_necessary_btn_text' => '<string>',
'banner_footer_content' => '<string>',
'banner_preferences_btn_text' => '<string>',
'btn_border_radius' => '<string>',
'consent_additional_description' => '<string>',
'consent_button_placement' => '<string>',
'consent_description' => '<string>',
'consent_duration_days' => 123,
'consent_layout' => '<string>',
'consent_mode' => '<string>',
'consent_position' => '<string>',
'consent_title' => '<string>',
'dark_mode' => '<string>',
'do_not_sell_description' => '<string>',
'do_not_sell_title' => '<string>',
'enable_banner_footer' => true,
'enable_tcf' => true,
'equal_weight_buttons' => true,
'floating_preferences_icon_position' => '<string>',
'force_consent' => true,
'language_autodetect' => '<string>',
'logo_url_dark' => '<string>',
'logo_url_light' => '<string>',
'modal_border_radius' => '<string>',
'name' => '<string>',
'preferences_accept_btn_text' => '<string>',
'preferences_accept_necessary_btn_text' => '<string>',
'preferences_control_level' => '<string>',
'privacy_policy_url' => '<string>',
'save_preferences_btn_text' => '<string>',
'settings_description' => '<string>',
'settings_layout' => '<string>',
'settings_more_info' => '<string>',
'settings_more_info_title' => '<string>',
'settings_position_x' => '<string>',
'settings_title' => '<string>',
'show_banner_accept_btn' => true,
'show_banner_accept_necessary_btn' => true,
'show_banner_close_btn' => true,
'show_banner_preferences_btn' => true,
'show_floating_preferences_icon' => true,
'show_preferences_accept_btn' => true,
'show_preferences_accept_necessary_btn' => true,
'show_save_preferences_btn' => true,
'show_services' => true,
'swap_buttons' => true,
'target_canadian_regions' => [
'<string>'
],
'target_countries' => [
'<string>'
],
'target_type' => '<string>',
'target_us_states' => [
'<string>'
],
'button_colors' => [
]
]
]),
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/consent-banners"
payload := strings.NewReader("{\n \"consent_banner\": {\n \"banner_accept_btn_text\": \"<string>\",\n \"banner_accept_necessary_btn_text\": \"<string>\",\n \"banner_footer_content\": \"<string>\",\n \"banner_preferences_btn_text\": \"<string>\",\n \"btn_border_radius\": \"<string>\",\n \"consent_additional_description\": \"<string>\",\n \"consent_button_placement\": \"<string>\",\n \"consent_description\": \"<string>\",\n \"consent_duration_days\": 123,\n \"consent_layout\": \"<string>\",\n \"consent_mode\": \"<string>\",\n \"consent_position\": \"<string>\",\n \"consent_title\": \"<string>\",\n \"dark_mode\": \"<string>\",\n \"do_not_sell_description\": \"<string>\",\n \"do_not_sell_title\": \"<string>\",\n \"enable_banner_footer\": true,\n \"enable_tcf\": true,\n \"equal_weight_buttons\": true,\n \"floating_preferences_icon_position\": \"<string>\",\n \"force_consent\": true,\n \"language_autodetect\": \"<string>\",\n \"logo_url_dark\": \"<string>\",\n \"logo_url_light\": \"<string>\",\n \"modal_border_radius\": \"<string>\",\n \"name\": \"<string>\",\n \"preferences_accept_btn_text\": \"<string>\",\n \"preferences_accept_necessary_btn_text\": \"<string>\",\n \"preferences_control_level\": \"<string>\",\n \"privacy_policy_url\": \"<string>\",\n \"save_preferences_btn_text\": \"<string>\",\n \"settings_description\": \"<string>\",\n \"settings_layout\": \"<string>\",\n \"settings_more_info\": \"<string>\",\n \"settings_more_info_title\": \"<string>\",\n \"settings_position_x\": \"<string>\",\n \"settings_title\": \"<string>\",\n \"show_banner_accept_btn\": true,\n \"show_banner_accept_necessary_btn\": true,\n \"show_banner_close_btn\": true,\n \"show_banner_preferences_btn\": true,\n \"show_floating_preferences_icon\": true,\n \"show_preferences_accept_btn\": true,\n \"show_preferences_accept_necessary_btn\": true,\n \"show_save_preferences_btn\": true,\n \"show_services\": true,\n \"swap_buttons\": true,\n \"target_canadian_regions\": [\n \"<string>\"\n ],\n \"target_countries\": [\n \"<string>\"\n ],\n \"target_type\": \"<string>\",\n \"target_us_states\": [\n \"<string>\"\n ],\n \"button_colors\": {}\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/consent-banners")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"consent_banner\": {\n \"banner_accept_btn_text\": \"<string>\",\n \"banner_accept_necessary_btn_text\": \"<string>\",\n \"banner_footer_content\": \"<string>\",\n \"banner_preferences_btn_text\": \"<string>\",\n \"btn_border_radius\": \"<string>\",\n \"consent_additional_description\": \"<string>\",\n \"consent_button_placement\": \"<string>\",\n \"consent_description\": \"<string>\",\n \"consent_duration_days\": 123,\n \"consent_layout\": \"<string>\",\n \"consent_mode\": \"<string>\",\n \"consent_position\": \"<string>\",\n \"consent_title\": \"<string>\",\n \"dark_mode\": \"<string>\",\n \"do_not_sell_description\": \"<string>\",\n \"do_not_sell_title\": \"<string>\",\n \"enable_banner_footer\": true,\n \"enable_tcf\": true,\n \"equal_weight_buttons\": true,\n \"floating_preferences_icon_position\": \"<string>\",\n \"force_consent\": true,\n \"language_autodetect\": \"<string>\",\n \"logo_url_dark\": \"<string>\",\n \"logo_url_light\": \"<string>\",\n \"modal_border_radius\": \"<string>\",\n \"name\": \"<string>\",\n \"preferences_accept_btn_text\": \"<string>\",\n \"preferences_accept_necessary_btn_text\": \"<string>\",\n \"preferences_control_level\": \"<string>\",\n \"privacy_policy_url\": \"<string>\",\n \"save_preferences_btn_text\": \"<string>\",\n \"settings_description\": \"<string>\",\n \"settings_layout\": \"<string>\",\n \"settings_more_info\": \"<string>\",\n \"settings_more_info_title\": \"<string>\",\n \"settings_position_x\": \"<string>\",\n \"settings_title\": \"<string>\",\n \"show_banner_accept_btn\": true,\n \"show_banner_accept_necessary_btn\": true,\n \"show_banner_close_btn\": true,\n \"show_banner_preferences_btn\": true,\n \"show_floating_preferences_icon\": true,\n \"show_preferences_accept_btn\": true,\n \"show_preferences_accept_necessary_btn\": true,\n \"show_save_preferences_btn\": true,\n \"show_services\": true,\n \"swap_buttons\": true,\n \"target_canadian_regions\": [\n \"<string>\"\n ],\n \"target_countries\": [\n \"<string>\"\n ],\n \"target_type\": \"<string>\",\n \"target_us_states\": [\n \"<string>\"\n ],\n \"button_colors\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cookiechimp.com/api/v1/consent-banners")
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 \"consent_banner\": {\n \"banner_accept_btn_text\": \"<string>\",\n \"banner_accept_necessary_btn_text\": \"<string>\",\n \"banner_footer_content\": \"<string>\",\n \"banner_preferences_btn_text\": \"<string>\",\n \"btn_border_radius\": \"<string>\",\n \"consent_additional_description\": \"<string>\",\n \"consent_button_placement\": \"<string>\",\n \"consent_description\": \"<string>\",\n \"consent_duration_days\": 123,\n \"consent_layout\": \"<string>\",\n \"consent_mode\": \"<string>\",\n \"consent_position\": \"<string>\",\n \"consent_title\": \"<string>\",\n \"dark_mode\": \"<string>\",\n \"do_not_sell_description\": \"<string>\",\n \"do_not_sell_title\": \"<string>\",\n \"enable_banner_footer\": true,\n \"enable_tcf\": true,\n \"equal_weight_buttons\": true,\n \"floating_preferences_icon_position\": \"<string>\",\n \"force_consent\": true,\n \"language_autodetect\": \"<string>\",\n \"logo_url_dark\": \"<string>\",\n \"logo_url_light\": \"<string>\",\n \"modal_border_radius\": \"<string>\",\n \"name\": \"<string>\",\n \"preferences_accept_btn_text\": \"<string>\",\n \"preferences_accept_necessary_btn_text\": \"<string>\",\n \"preferences_control_level\": \"<string>\",\n \"privacy_policy_url\": \"<string>\",\n \"save_preferences_btn_text\": \"<string>\",\n \"settings_description\": \"<string>\",\n \"settings_layout\": \"<string>\",\n \"settings_more_info\": \"<string>\",\n \"settings_more_info_title\": \"<string>\",\n \"settings_position_x\": \"<string>\",\n \"settings_title\": \"<string>\",\n \"show_banner_accept_btn\": true,\n \"show_banner_accept_necessary_btn\": true,\n \"show_banner_close_btn\": true,\n \"show_banner_preferences_btn\": true,\n \"show_floating_preferences_icon\": true,\n \"show_preferences_accept_btn\": true,\n \"show_preferences_accept_necessary_btn\": true,\n \"show_save_preferences_btn\": true,\n \"show_services\": true,\n \"swap_buttons\": true,\n \"target_canadian_regions\": [\n \"<string>\"\n ],\n \"target_countries\": [\n \"<string>\"\n ],\n \"target_type\": \"<string>\",\n \"target_us_states\": [\n \"<string>\"\n ],\n \"button_colors\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "ban1",
"name": "EU banner",
"enabled": true,
"enable_tcf": false,
"force_consent": false,
"consent_mode": "opt_in",
"consent_duration_days": 180,
"consent_layout": "box",
"consent_position": "bottom_center",
"consent_title": "We use cookies",
"consent_description": "We use cookies to improve your experience.",
"privacy_policy_url": "https://example.com/privacy",
"preferences_control_level": "category_and_services",
"dark_mode": "light",
"language_autodetect": "document",
"revision": 2,
"target_type": "selected_countries",
"target_countries": [
"DE",
"FR"
],
"target_us_states": [],
"target_canadian_regions": [],
"translations": [
{
"id": "trn1",
"language_code": "de"
},
{
"id": "trn2",
"language_code": "fr"
}
],
"created_at": "2023-01-05T10:15:30Z",
"updated_at": "2023-02-01T08: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
API token obtained from the login endpoint or the dashboard
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.
Body
application/json
Consent banner to create
Translations are not accepted here — add them by updating the banner, which is where the account's language entitlement is enforced.
The create payload: every banner setting except enabled, which is not
part of it because a new banner is always created disabled — enable it
with an update once its content and targeting are set. Sending enabled
anyway is not an error, the value is simply ignored.
Show child attributes
Show child attributes
Response
Created consent banner
Every setting the update endpoint accepts, plus the read-only fields below — the response is derived from the same list the API permits, so a banner can be read, edited and sent back unchanged.
Show child attributes
Show child attributes
Example:
{
"id": "ban1",
"name": "EU banner",
"enabled": true,
"enable_tcf": false,
"force_consent": false,
"consent_mode": "opt_in",
"consent_duration_days": 180,
"consent_layout": "box",
"consent_position": "bottom_center",
"consent_title": "We use cookies",
"consent_description": "We use cookies to improve your experience.",
"privacy_policy_url": "https://example.com/privacy",
"preferences_control_level": "category_and_services",
"dark_mode": "light",
"language_autodetect": "document",
"revision": 2,
"target_type": "selected_countries",
"target_countries": ["DE", "FR"],
"target_us_states": [],
"target_canadian_regions": [],
"translations": [
{ "id": "trn1", "language_code": "de" },
{ "id": "trn2", "language_code": "fr" }
],
"created_at": "2023-01-05T10:15:30Z",
"updated_at": "2023-02-01T08:00:00Z"
}
Was this page helpful?
⌘I
Create consent banner
curl --request POST \
--url https://cookiechimp.com/api/v1/consent-banners \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"consent_banner": {
"banner_accept_btn_text": "<string>",
"banner_accept_necessary_btn_text": "<string>",
"banner_footer_content": "<string>",
"banner_preferences_btn_text": "<string>",
"btn_border_radius": "<string>",
"consent_additional_description": "<string>",
"consent_button_placement": "<string>",
"consent_description": "<string>",
"consent_duration_days": 123,
"consent_layout": "<string>",
"consent_mode": "<string>",
"consent_position": "<string>",
"consent_title": "<string>",
"dark_mode": "<string>",
"do_not_sell_description": "<string>",
"do_not_sell_title": "<string>",
"enable_banner_footer": true,
"enable_tcf": true,
"equal_weight_buttons": true,
"floating_preferences_icon_position": "<string>",
"force_consent": true,
"language_autodetect": "<string>",
"logo_url_dark": "<string>",
"logo_url_light": "<string>",
"modal_border_radius": "<string>",
"name": "<string>",
"preferences_accept_btn_text": "<string>",
"preferences_accept_necessary_btn_text": "<string>",
"preferences_control_level": "<string>",
"privacy_policy_url": "<string>",
"save_preferences_btn_text": "<string>",
"settings_description": "<string>",
"settings_layout": "<string>",
"settings_more_info": "<string>",
"settings_more_info_title": "<string>",
"settings_position_x": "<string>",
"settings_title": "<string>",
"show_banner_accept_btn": true,
"show_banner_accept_necessary_btn": true,
"show_banner_close_btn": true,
"show_banner_preferences_btn": true,
"show_floating_preferences_icon": true,
"show_preferences_accept_btn": true,
"show_preferences_accept_necessary_btn": true,
"show_save_preferences_btn": true,
"show_services": true,
"swap_buttons": true,
"target_canadian_regions": [
"<string>"
],
"target_countries": [
"<string>"
],
"target_type": "<string>",
"target_us_states": [
"<string>"
],
"button_colors": {}
}
}
'import requests
url = "https://cookiechimp.com/api/v1/consent-banners"
payload = { "consent_banner": {
"banner_accept_btn_text": "<string>",
"banner_accept_necessary_btn_text": "<string>",
"banner_footer_content": "<string>",
"banner_preferences_btn_text": "<string>",
"btn_border_radius": "<string>",
"consent_additional_description": "<string>",
"consent_button_placement": "<string>",
"consent_description": "<string>",
"consent_duration_days": 123,
"consent_layout": "<string>",
"consent_mode": "<string>",
"consent_position": "<string>",
"consent_title": "<string>",
"dark_mode": "<string>",
"do_not_sell_description": "<string>",
"do_not_sell_title": "<string>",
"enable_banner_footer": True,
"enable_tcf": True,
"equal_weight_buttons": True,
"floating_preferences_icon_position": "<string>",
"force_consent": True,
"language_autodetect": "<string>",
"logo_url_dark": "<string>",
"logo_url_light": "<string>",
"modal_border_radius": "<string>",
"name": "<string>",
"preferences_accept_btn_text": "<string>",
"preferences_accept_necessary_btn_text": "<string>",
"preferences_control_level": "<string>",
"privacy_policy_url": "<string>",
"save_preferences_btn_text": "<string>",
"settings_description": "<string>",
"settings_layout": "<string>",
"settings_more_info": "<string>",
"settings_more_info_title": "<string>",
"settings_position_x": "<string>",
"settings_title": "<string>",
"show_banner_accept_btn": True,
"show_banner_accept_necessary_btn": True,
"show_banner_close_btn": True,
"show_banner_preferences_btn": True,
"show_floating_preferences_icon": True,
"show_preferences_accept_btn": True,
"show_preferences_accept_necessary_btn": True,
"show_save_preferences_btn": True,
"show_services": True,
"swap_buttons": True,
"target_canadian_regions": ["<string>"],
"target_countries": ["<string>"],
"target_type": "<string>",
"target_us_states": ["<string>"],
"button_colors": {}
} }
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({
consent_banner: {
banner_accept_btn_text: '<string>',
banner_accept_necessary_btn_text: '<string>',
banner_footer_content: '<string>',
banner_preferences_btn_text: '<string>',
btn_border_radius: '<string>',
consent_additional_description: '<string>',
consent_button_placement: '<string>',
consent_description: '<string>',
consent_duration_days: 123,
consent_layout: '<string>',
consent_mode: '<string>',
consent_position: '<string>',
consent_title: '<string>',
dark_mode: '<string>',
do_not_sell_description: '<string>',
do_not_sell_title: '<string>',
enable_banner_footer: true,
enable_tcf: true,
equal_weight_buttons: true,
floating_preferences_icon_position: '<string>',
force_consent: true,
language_autodetect: '<string>',
logo_url_dark: '<string>',
logo_url_light: '<string>',
modal_border_radius: '<string>',
name: '<string>',
preferences_accept_btn_text: '<string>',
preferences_accept_necessary_btn_text: '<string>',
preferences_control_level: '<string>',
privacy_policy_url: '<string>',
save_preferences_btn_text: '<string>',
settings_description: '<string>',
settings_layout: '<string>',
settings_more_info: '<string>',
settings_more_info_title: '<string>',
settings_position_x: '<string>',
settings_title: '<string>',
show_banner_accept_btn: true,
show_banner_accept_necessary_btn: true,
show_banner_close_btn: true,
show_banner_preferences_btn: true,
show_floating_preferences_icon: true,
show_preferences_accept_btn: true,
show_preferences_accept_necessary_btn: true,
show_save_preferences_btn: true,
show_services: true,
swap_buttons: true,
target_canadian_regions: ['<string>'],
target_countries: ['<string>'],
target_type: '<string>',
target_us_states: ['<string>'],
button_colors: {}
}
})
};
fetch('https://cookiechimp.com/api/v1/consent-banners', 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/consent-banners",
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([
'consent_banner' => [
'banner_accept_btn_text' => '<string>',
'banner_accept_necessary_btn_text' => '<string>',
'banner_footer_content' => '<string>',
'banner_preferences_btn_text' => '<string>',
'btn_border_radius' => '<string>',
'consent_additional_description' => '<string>',
'consent_button_placement' => '<string>',
'consent_description' => '<string>',
'consent_duration_days' => 123,
'consent_layout' => '<string>',
'consent_mode' => '<string>',
'consent_position' => '<string>',
'consent_title' => '<string>',
'dark_mode' => '<string>',
'do_not_sell_description' => '<string>',
'do_not_sell_title' => '<string>',
'enable_banner_footer' => true,
'enable_tcf' => true,
'equal_weight_buttons' => true,
'floating_preferences_icon_position' => '<string>',
'force_consent' => true,
'language_autodetect' => '<string>',
'logo_url_dark' => '<string>',
'logo_url_light' => '<string>',
'modal_border_radius' => '<string>',
'name' => '<string>',
'preferences_accept_btn_text' => '<string>',
'preferences_accept_necessary_btn_text' => '<string>',
'preferences_control_level' => '<string>',
'privacy_policy_url' => '<string>',
'save_preferences_btn_text' => '<string>',
'settings_description' => '<string>',
'settings_layout' => '<string>',
'settings_more_info' => '<string>',
'settings_more_info_title' => '<string>',
'settings_position_x' => '<string>',
'settings_title' => '<string>',
'show_banner_accept_btn' => true,
'show_banner_accept_necessary_btn' => true,
'show_banner_close_btn' => true,
'show_banner_preferences_btn' => true,
'show_floating_preferences_icon' => true,
'show_preferences_accept_btn' => true,
'show_preferences_accept_necessary_btn' => true,
'show_save_preferences_btn' => true,
'show_services' => true,
'swap_buttons' => true,
'target_canadian_regions' => [
'<string>'
],
'target_countries' => [
'<string>'
],
'target_type' => '<string>',
'target_us_states' => [
'<string>'
],
'button_colors' => [
]
]
]),
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/consent-banners"
payload := strings.NewReader("{\n \"consent_banner\": {\n \"banner_accept_btn_text\": \"<string>\",\n \"banner_accept_necessary_btn_text\": \"<string>\",\n \"banner_footer_content\": \"<string>\",\n \"banner_preferences_btn_text\": \"<string>\",\n \"btn_border_radius\": \"<string>\",\n \"consent_additional_description\": \"<string>\",\n \"consent_button_placement\": \"<string>\",\n \"consent_description\": \"<string>\",\n \"consent_duration_days\": 123,\n \"consent_layout\": \"<string>\",\n \"consent_mode\": \"<string>\",\n \"consent_position\": \"<string>\",\n \"consent_title\": \"<string>\",\n \"dark_mode\": \"<string>\",\n \"do_not_sell_description\": \"<string>\",\n \"do_not_sell_title\": \"<string>\",\n \"enable_banner_footer\": true,\n \"enable_tcf\": true,\n \"equal_weight_buttons\": true,\n \"floating_preferences_icon_position\": \"<string>\",\n \"force_consent\": true,\n \"language_autodetect\": \"<string>\",\n \"logo_url_dark\": \"<string>\",\n \"logo_url_light\": \"<string>\",\n \"modal_border_radius\": \"<string>\",\n \"name\": \"<string>\",\n \"preferences_accept_btn_text\": \"<string>\",\n \"preferences_accept_necessary_btn_text\": \"<string>\",\n \"preferences_control_level\": \"<string>\",\n \"privacy_policy_url\": \"<string>\",\n \"save_preferences_btn_text\": \"<string>\",\n \"settings_description\": \"<string>\",\n \"settings_layout\": \"<string>\",\n \"settings_more_info\": \"<string>\",\n \"settings_more_info_title\": \"<string>\",\n \"settings_position_x\": \"<string>\",\n \"settings_title\": \"<string>\",\n \"show_banner_accept_btn\": true,\n \"show_banner_accept_necessary_btn\": true,\n \"show_banner_close_btn\": true,\n \"show_banner_preferences_btn\": true,\n \"show_floating_preferences_icon\": true,\n \"show_preferences_accept_btn\": true,\n \"show_preferences_accept_necessary_btn\": true,\n \"show_save_preferences_btn\": true,\n \"show_services\": true,\n \"swap_buttons\": true,\n \"target_canadian_regions\": [\n \"<string>\"\n ],\n \"target_countries\": [\n \"<string>\"\n ],\n \"target_type\": \"<string>\",\n \"target_us_states\": [\n \"<string>\"\n ],\n \"button_colors\": {}\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/consent-banners")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"consent_banner\": {\n \"banner_accept_btn_text\": \"<string>\",\n \"banner_accept_necessary_btn_text\": \"<string>\",\n \"banner_footer_content\": \"<string>\",\n \"banner_preferences_btn_text\": \"<string>\",\n \"btn_border_radius\": \"<string>\",\n \"consent_additional_description\": \"<string>\",\n \"consent_button_placement\": \"<string>\",\n \"consent_description\": \"<string>\",\n \"consent_duration_days\": 123,\n \"consent_layout\": \"<string>\",\n \"consent_mode\": \"<string>\",\n \"consent_position\": \"<string>\",\n \"consent_title\": \"<string>\",\n \"dark_mode\": \"<string>\",\n \"do_not_sell_description\": \"<string>\",\n \"do_not_sell_title\": \"<string>\",\n \"enable_banner_footer\": true,\n \"enable_tcf\": true,\n \"equal_weight_buttons\": true,\n \"floating_preferences_icon_position\": \"<string>\",\n \"force_consent\": true,\n \"language_autodetect\": \"<string>\",\n \"logo_url_dark\": \"<string>\",\n \"logo_url_light\": \"<string>\",\n \"modal_border_radius\": \"<string>\",\n \"name\": \"<string>\",\n \"preferences_accept_btn_text\": \"<string>\",\n \"preferences_accept_necessary_btn_text\": \"<string>\",\n \"preferences_control_level\": \"<string>\",\n \"privacy_policy_url\": \"<string>\",\n \"save_preferences_btn_text\": \"<string>\",\n \"settings_description\": \"<string>\",\n \"settings_layout\": \"<string>\",\n \"settings_more_info\": \"<string>\",\n \"settings_more_info_title\": \"<string>\",\n \"settings_position_x\": \"<string>\",\n \"settings_title\": \"<string>\",\n \"show_banner_accept_btn\": true,\n \"show_banner_accept_necessary_btn\": true,\n \"show_banner_close_btn\": true,\n \"show_banner_preferences_btn\": true,\n \"show_floating_preferences_icon\": true,\n \"show_preferences_accept_btn\": true,\n \"show_preferences_accept_necessary_btn\": true,\n \"show_save_preferences_btn\": true,\n \"show_services\": true,\n \"swap_buttons\": true,\n \"target_canadian_regions\": [\n \"<string>\"\n ],\n \"target_countries\": [\n \"<string>\"\n ],\n \"target_type\": \"<string>\",\n \"target_us_states\": [\n \"<string>\"\n ],\n \"button_colors\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cookiechimp.com/api/v1/consent-banners")
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 \"consent_banner\": {\n \"banner_accept_btn_text\": \"<string>\",\n \"banner_accept_necessary_btn_text\": \"<string>\",\n \"banner_footer_content\": \"<string>\",\n \"banner_preferences_btn_text\": \"<string>\",\n \"btn_border_radius\": \"<string>\",\n \"consent_additional_description\": \"<string>\",\n \"consent_button_placement\": \"<string>\",\n \"consent_description\": \"<string>\",\n \"consent_duration_days\": 123,\n \"consent_layout\": \"<string>\",\n \"consent_mode\": \"<string>\",\n \"consent_position\": \"<string>\",\n \"consent_title\": \"<string>\",\n \"dark_mode\": \"<string>\",\n \"do_not_sell_description\": \"<string>\",\n \"do_not_sell_title\": \"<string>\",\n \"enable_banner_footer\": true,\n \"enable_tcf\": true,\n \"equal_weight_buttons\": true,\n \"floating_preferences_icon_position\": \"<string>\",\n \"force_consent\": true,\n \"language_autodetect\": \"<string>\",\n \"logo_url_dark\": \"<string>\",\n \"logo_url_light\": \"<string>\",\n \"modal_border_radius\": \"<string>\",\n \"name\": \"<string>\",\n \"preferences_accept_btn_text\": \"<string>\",\n \"preferences_accept_necessary_btn_text\": \"<string>\",\n \"preferences_control_level\": \"<string>\",\n \"privacy_policy_url\": \"<string>\",\n \"save_preferences_btn_text\": \"<string>\",\n \"settings_description\": \"<string>\",\n \"settings_layout\": \"<string>\",\n \"settings_more_info\": \"<string>\",\n \"settings_more_info_title\": \"<string>\",\n \"settings_position_x\": \"<string>\",\n \"settings_title\": \"<string>\",\n \"show_banner_accept_btn\": true,\n \"show_banner_accept_necessary_btn\": true,\n \"show_banner_close_btn\": true,\n \"show_banner_preferences_btn\": true,\n \"show_floating_preferences_icon\": true,\n \"show_preferences_accept_btn\": true,\n \"show_preferences_accept_necessary_btn\": true,\n \"show_save_preferences_btn\": true,\n \"show_services\": true,\n \"swap_buttons\": true,\n \"target_canadian_regions\": [\n \"<string>\"\n ],\n \"target_countries\": [\n \"<string>\"\n ],\n \"target_type\": \"<string>\",\n \"target_us_states\": [\n \"<string>\"\n ],\n \"button_colors\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "ban1",
"name": "EU banner",
"enabled": true,
"enable_tcf": false,
"force_consent": false,
"consent_mode": "opt_in",
"consent_duration_days": 180,
"consent_layout": "box",
"consent_position": "bottom_center",
"consent_title": "We use cookies",
"consent_description": "We use cookies to improve your experience.",
"privacy_policy_url": "https://example.com/privacy",
"preferences_control_level": "category_and_services",
"dark_mode": "light",
"language_autodetect": "document",
"revision": 2,
"target_type": "selected_countries",
"target_countries": [
"DE",
"FR"
],
"target_us_states": [],
"target_canadian_regions": [],
"translations": [
{
"id": "trn1",
"language_code": "de"
},
{
"id": "trn2",
"language_code": "fr"
}
],
"created_at": "2023-01-05T10:15:30Z",
"updated_at": "2023-02-01T08: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."
}
]
}