Integrations

Update integration

Enable, disable or configure an integration. Every integration accepts status; the rest of the accepted keys depend on which integration it is, and anything else is ignored.

SiteScanIntegration also accepts scan_frequency (weekly or monthly; weekly is not available on free accounts) and auto_add_vendors.
GoogleConsentModeIntegration also accepts url_passthrough and ads_data_redaction.

Enabling an integration may add its associated vendors to the account.

Scheduled scanning is a paid feature: on a free plan, setting SiteScanIntegration to active or turning on auto_add_vendors is refused with a 422. Turning it off always works, so an account that downgrades can still disable it.

PUT

integrations

{id}

Update integration

curl --request PUT \
  --url https://cookiechimp.com/api/v1/integrations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration": {
    "status": "active",
    "scan_frequency": "monthly",
    "auto_add_vendors": true
  }
}
'

import requests

url = "https://cookiechimp.com/api/v1/integrations/{id}"

payload = { "integration": {
        "status": "active",
        "scan_frequency": "monthly",
        "auto_add_vendors": True
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    integration: {status: 'active', scan_frequency: 'monthly', auto_add_vendors: true}
  })
};

fetch('https://cookiechimp.com/api/v1/integrations/{id}', 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/integrations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'integration' => [
        'status' => 'active',
        'scan_frequency' => 'monthly',
        'auto_add_vendors' => true
    ]
  ]),
  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/integrations/{id}"

	payload := strings.NewReader("{\n  \"integration\": {\n    \"status\": \"active\",\n    \"scan_frequency\": \"monthly\",\n    \"auto_add_vendors\": true\n  }\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://cookiechimp.com/api/v1/integrations/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"integration\": {\n    \"status\": \"active\",\n    \"scan_frequency\": \"monthly\",\n    \"auto_add_vendors\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cookiechimp.com/api/v1/integrations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"integration\": {\n    \"status\": \"active\",\n    \"scan_frequency\": \"monthly\",\n    \"auto_add_vendors\": true\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "int1",
    "type": "SiteScanIntegration",
    "name": "Site Scan",
    "status": "active",
    "short_description": "Scan your website for cookies on a schedule.",
    "settings": {
      "scan_frequency": "monthly",
      "auto_add_vendors": false
    },
    "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": [
    {
      "code": 404,
      "message": "Record not found"
    }
  ]
}

{
  "errors": [
    {
      "error": "Name can't be blank"
    }
  ]
}

{
  "errors": [
    {
      "code": 429,
      "message": "Too many requests. Please retry later."
    }
  ]
}

Authorizations

Authorization

string

header

required

API token obtained from the login endpoint or the dashboard

Path Parameters

string

required

ID of the resource

Query Parameters

account_id

string

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

Integration settings to update

integration

object

required

status applies to every integration. The remaining keys are only accepted by the integration that declares them; anything else is ignored.

Show child attributes

Response

Updated integration

data

object

Show child attributes

Example:

{
  "id": "int1",
  "type": "SiteScanIntegration",
  "name": "Site Scan",
  "status": "active",
  "short_description": "Scan your website for cookies on a schedule.",
  "settings": {
    "scan_frequency": "monthly",
    "auto_add_vendors": false
  },
  "created_at": "2023-01-05T10:15:30Z",
  "updated_at": "2023-02-01T08:00:00Z"
}

Update integration

curl --request PUT \
  --url https://cookiechimp.com/api/v1/integrations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration": {
    "status": "active",
    "scan_frequency": "monthly",
    "auto_add_vendors": true
  }
}
'

import requests

url = "https://cookiechimp.com/api/v1/integrations/{id}"

payload = { "integration": {
        "status": "active",
        "scan_frequency": "monthly",
        "auto_add_vendors": True
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    integration: {status: 'active', scan_frequency: 'monthly', auto_add_vendors: true}
  })
};

fetch('https://cookiechimp.com/api/v1/integrations/{id}', 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/integrations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'integration' => [
        'status' => 'active',
        'scan_frequency' => 'monthly',
        'auto_add_vendors' => true
    ]
  ]),
  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/integrations/{id}"

	payload := strings.NewReader("{\n  \"integration\": {\n    \"status\": \"active\",\n    \"scan_frequency\": \"monthly\",\n    \"auto_add_vendors\": true\n  }\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://cookiechimp.com/api/v1/integrations/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"integration\": {\n    \"status\": \"active\",\n    \"scan_frequency\": \"monthly\",\n    \"auto_add_vendors\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cookiechimp.com/api/v1/integrations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"integration\": {\n    \"status\": \"active\",\n    \"scan_frequency\": \"monthly\",\n    \"auto_add_vendors\": true\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "int1",
    "type": "SiteScanIntegration",
    "name": "Site Scan",
    "status": "active",
    "short_description": "Scan your website for cookies on a schedule.",
    "settings": {
      "scan_frequency": "monthly",
      "auto_add_vendors": false
    },
    "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": [
    {
      "code": 404,
      "message": "Record not found"
    }
  ]
}

{
  "errors": [
    {
      "error": "Name can't be blank"
    }
  ]
}

{
  "errors": [
    {
      "code": 429,
      "message": "Too many requests. Please retry later."
    }
  ]
}

API Documentation

Auth

Partner Integration

Account

Consent Banners

Services

Compliance

Scans

Integrations

Account Users

Account Invitations

AI Actions

Storage Items

Categories

Consents

Groups

Update integration

Authorizations

Path Parameters

Query Parameters

Body

Response