Consents
Create a Consent
Consents
Create a Consent
Create a new consent record
POST
/
consents
X-API-KEY
string
*
X-API-KEY
Required
string
object
*
user_id
string
user_id
string
ID of the user set by your website
user_preferences
object
*
user_preferences
Required
object
accept_type
enum<string>
accept_type
enum<string>
accepted_categories
array
accepted_categories
array
rejected_categories
array
rejected_categories
array
accepted_services
object
accepted_services
object
rejected_services
object
rejected_services
object
curl --request POST \
--url https://cookiechimp.com/api/v1/consents \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"user_id": "<string>",
"user_preferences": {
"accept_type": "all",
"accepted_categories": [
"<string>"
],
"rejected_categories": [
"<string>"
],
"accepted_services": {},
"rejected_services": {}
}
}'
{
"id": "consent321",
"session_id": "sess123",
"user_id": "user456",
"user_preferences": {
"accept_type": "all",
"accepted_categories": [
"cat1",
"cat2"
],
"rejected_categories": [
"cat3",
"cat4"
],
"accepted_services": {
"company1": [
"cookie1",
"cookie2"
]
},
"rejected_services": {}
},
"created_at": "2023-01-20T12:46:30Z"
}
Authorizations
X-API-KEY
string
headerrequiredBody
application/json
user_id
string
ID of the user set by your website
user_preferences
object
requireduser_preferences.accept_type
enum<string>
Available options:
all
, custom
, necessary
user_preferences.accepted_categories
string[]
user_preferences.rejected_categories
string[]
user_preferences.accepted_services
object
user_preferences.rejected_services
object
Response
201 - application/json
user_id
string
ID of the user set by your website
user_preferences
object
requireduser_preferences.accept_type
enum<string>
Available options:
all
, custom
, necessary
user_preferences.accepted_categories
string[]
user_preferences.rejected_categories
string[]
user_preferences.accepted_services
object
user_preferences.rejected_services
object
id
string
Unique identifier for the consent
session_id
string
ID of the session
created_at
string
Date and time when the consent was created
curl --request POST \
--url https://cookiechimp.com/api/v1/consents \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"user_id": "<string>",
"user_preferences": {
"accept_type": "all",
"accepted_categories": [
"<string>"
],
"rejected_categories": [
"<string>"
],
"accepted_services": {},
"rejected_services": {}
}
}'
{
"id": "consent321",
"session_id": "sess123",
"user_id": "user456",
"user_preferences": {
"accept_type": "all",
"accepted_categories": [
"cat1",
"cat2"
],
"rejected_categories": [
"cat3",
"cat4"
],
"accepted_services": {
"company1": [
"cookie1",
"cookie2"
]
},
"rejected_services": {}
},
"created_at": "2023-01-20T12:46:30Z"
}