Skip to main content

Create organization

Creates a new organization.

Request Body REQUIRED
name string REQUIRED

Possible values: 3 ≤ length ≤ 1024

The name of the new organization

contactEmails email[]
regionTemplate object
name string

Possible values: length ≤ 256

regions
customScript
settings object
branding object
logoUrl string
primaryColor string
secondaryColor string
consent object
blockingMode string

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

consentMode string

Possible values: [implied, express]

consentBanner object
enabled boolean
position string
policy uuid
title boolean
theme string

Possible values: [light, dark]

closeButton boolean
denyButton boolean
customizeButton boolean
doNotSell boolean
gpc boolean
limitPii boolean
crossSiteTracking boolean
floatingButton object
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
consentHistory boolean
disclosures boolean
privacyRequests boolean
doNotSellRequests boolean
position string
theme string

Possible values: [light, dark]

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

Possible values: length ≤ 256

privacyPolicyUrl string REQUIRED
subscription object
interval string REQUIRED

Possible values: [month, year]

plan string REQUIRED

Possible values: [free, essentials, pro, premium, enterprise]

addons object
dataSystems integer
domains integer
users integer
collectPayment boolean
test boolean
termsOfServiceUrl string
Responses
201

Default Response

Schema OPTIONAL
createdAt OPTIONAL
updatedAt OPTIONAL
defaultProjectId OPTIONAL
billingEmails OPTIONAL
billingPhoneNumber OPTIONAL
billingAddress OPTIONAL
subscription OPTIONAL
id uuid OPTIONAL
name string

Possible values: 3 ≤ length ≤ 1024

dateCreated integer
dateUpdated integer
primaryDomain string
slug string

Possible values: length ≤ 256

projects object[] OPTIONAL
default OPTIONAL
contactEmail email OPTIONAL
contactEmails email[] OPTIONAL
dateCreated integer
dateUpdated integer
id uuid
mode OPTIONAL
name string

Possible values: 3 ≤ length ≤ 1024

organizationId uuid
organization object OPTIONAL
id uuid
name string

Possible values: 3 ≤ length ≤ 1024

slug string

Possible values: length ≤ 256

status string OPTIONAL
sendFromEmailId OPTIONAL
sendFromEmail object OPTIONAL
id OPTIONAL
email email OPTIONAL
name string OPTIONAL
slug string

Possible values: length ≤ 256

status string OPTIONAL

Possible values: [active, test, archived]

statusFlags object
isActive OPTIONAL
isTest OPTIONAL
type

Possible values: [website]

status string OPTIONAL

Possible values: [active, suspended, disabled, deleted]

statusDate integer
statusFlags object
isActive OPTIONAL
features OPTIONAL
stripe object OPTIONAL
customerId string OPTIONAL
subscriptionId string OPTIONAL
clientSecret string OPTIONAL
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"