Skip to main content

Create region

Creates a new region.

Path Parameters
organizationId uuid REQUIRED
projectId uuid REQUIRED
Request Body REQUIRED
name string REQUIRED

Possible values: length ≤ 256

regions REQUIRED
customScript string

Possible values: length ≤ 10240

settings object REQUIRED
branding object
logoUrl string REQUIRED
primaryColor string REQUIRED
secondaryColor string REQUIRED
consent object REQUIRED
blockingMode string REQUIRED

Possible values: [disabled, discovery, permissive, strict]

consentMode string REQUIRED

Possible values: [implied, express]

consentBanner object
enabled boolean REQUIRED
position string REQUIRED
policy object
createdAt
updatedAt
id uuid REQUIRED
organization
project REQUIRED
category
subcategory
label string

Possible values: length ≤ 128, Value must match regular expression [a-z0-9_*]{1,128}$

version integer REQUIRED
dateCreated date-time
dateUpdated date-time
name string REQUIRED

Possible values: length ≤ 100

description string REQUIRED

Possible values: length ≤ 2000

document string

Possible values: length ≤ 5000000

url uri
readOnly boolean
validStates string[]

Possible values: [implied, viewed, accepted, declined]

status string

Possible values: [active, archived, obsolete, test]

consentDuration string
required boolean
requireReacceptVersion integer
title boolean REQUIRED
theme string REQUIRED

Possible values: [light, dark]

closeButton boolean REQUIRED
denyButton boolean REQUIRED
customizeButton boolean REQUIRED
doNotSell boolean REQUIRED
gpc boolean REQUIRED
limitPii boolean
crossSiteTracking boolean
floatingButton object
enabled boolean REQUIRED
position string REQUIRED
theme string REQUIRED

Possible values: [light, brand, dark]

type string REQUIRED

Possible values: [circle, tab]

icon string REQUIRED

Possible values: [cookie, fingerprint]

privacyCenter object
consentHistory boolean REQUIRED
disclosures boolean REQUIRED
privacyRequests boolean REQUIRED
doNotSellRequests boolean REQUIRED
position string REQUIRED
theme string REQUIRED

Possible values: [light, dark]

language object
consentBanner object REQUIRED
title
text
link
acceptButton
denyButton
customizeButton
floatingButton object REQUIRED
tab
privacyCenter object REQUIRED
consentHistory object REQUIRED
title
disclosures object REQUIRED
title
text
privacyRequests object REQUIRED
title
text
optionsButton
changeRequest object REQUIRED
title
text
deleteRequest object REQUIRED
title
text
doNotSellRequest object REQUIRED
title
text
viewRequest object REQUIRED
title
text
Responses
201

Default Response

Schema OPTIONAL
name string

Possible values: length ≤ 256

regions
customScript string OPTIONAL

Possible values: length ≤ 10240

settings object
branding object OPTIONAL
logoUrl string
primaryColor string
secondaryColor string
consent object
blockingMode string

Possible values: [disabled, discovery, permissive, strict]

consentMode string

Possible values: [implied, express]

consentBanner object OPTIONAL
enabled boolean
position string
policy object OPTIONAL
createdAt OPTIONAL
updatedAt OPTIONAL
id uuid
organization OPTIONAL
project
category OPTIONAL
subcategory OPTIONAL
label string OPTIONAL

Possible values: length ≤ 128, Value must match regular expression [a-z0-9_*]{1,128}$

version integer
dateCreated date-time OPTIONAL
dateUpdated date-time OPTIONAL
name string

Possible values: length ≤ 100

description string

Possible values: length ≤ 2000

document string OPTIONAL

Possible values: length ≤ 5000000

url uri OPTIONAL
readOnly boolean OPTIONAL
validStates string[] OPTIONAL

Possible values: [implied, viewed, accepted, declined]

status string OPTIONAL

Possible values: [active, archived, obsolete, test]

consentDuration string OPTIONAL
required boolean OPTIONAL
requireReacceptVersion integer OPTIONAL
title boolean
theme string

Possible values: [light, dark]

closeButton boolean
denyButton boolean
customizeButton boolean
doNotSell boolean
gpc boolean
limitPii boolean OPTIONAL
crossSiteTracking boolean OPTIONAL
floatingButton object OPTIONAL
enabled boolean
position string
theme string

Possible values: [light, brand, dark]

type string

Possible values: [circle, tab]

icon string

Possible values: [cookie, fingerprint]

privacyCenter object OPTIONAL
consentHistory boolean
disclosures boolean
privacyRequests boolean
doNotSellRequests boolean
position string
theme string

Possible values: [light, dark]

language object OPTIONAL
consentBanner object
title OPTIONAL
text OPTIONAL
link OPTIONAL
acceptButton OPTIONAL
denyButton OPTIONAL
customizeButton OPTIONAL
floatingButton object
tab OPTIONAL
privacyCenter object
consentHistory object
title OPTIONAL
disclosures object
title OPTIONAL
text OPTIONAL
privacyRequests object
title OPTIONAL
text OPTIONAL
optionsButton OPTIONAL
changeRequest object
title OPTIONAL
text OPTIONAL
deleteRequest object
title OPTIONAL
text OPTIONAL
doNotSellRequest object
title OPTIONAL
text OPTIONAL
viewRequest object
title OPTIONAL
text OPTIONAL
id uuid
projectId uuid
dateCreated integer
dateUpdated integer
slug string

Possible values: length ≤ 256

400

Bad request response.

Schema OPTIONAL
statusCode int32

The status code of the request.

error string

The error string for the status code.

message string

Description of the error encounted.

401

Unauthorized response.

Schema OPTIONAL
statusCode int32

The status code of the request.

error string

The error string for the status code.

message string
403

Forbidden response.

Schema OPTIONAL
statusCode int32

The status code of the request.

error string
message string
404

Not found response.

Schema OPTIONAL
statusCode int32
error string
message string
422

Unprocessable Entity response.

Schema OPTIONAL
statusCode int32
error string
message string

Description of the error encounted.

500

Internal server error response.

Schema OPTIONAL
statusCode int32
error string
message string

Will always be "Internal Server Error"