Skip to main content
POST
/
organizations
/
{organizationId}
/
projects
Create new project
curl --request POST \
  --url https://api.concord.tech/privacy-v1/organizations/{organizationId}/projects \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "type": "website",
  "contactEmails": [
    "[email protected]"
  ],
  "additionalRegions": [
    {
      "name": "<string>",
      "regions": "default",
      "settings": {
        "consent": {
          "blockingMode": "disabled",
          "consentMode": "implied",
          "doNotSell": false,
          "consentDuration": 12,
          "gcm": "advanced",
          "gpc": false,
          "consentBanner": {
            "enabled": true,
            "layout": "bar",
            "title": true,
            "theme": "light",
            "closeButton": true,
            "denyButton": true,
            "customizeButton": true,
            "position": [
              "<unknown>"
            ],
            "policy": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "version": 123,
              "name": "<string>",
              "description": "<string>",
              "createdAt": [
                "<unknown>"
              ],
              "updatedAt": [
                "<unknown>"
              ],
              "organization": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "category": "disclosure",
              "subcategory": [
                "<unknown>"
              ],
              "label": "<string>",
              "dateCreated": "2023-11-07T05:31:56Z",
              "dateUpdated": "2023-11-07T05:31:56Z",
              "document": "<string>",
              "url": "<string>",
              "readOnly": false,
              "validStates": [
                "implied"
              ],
              "status": "active",
              "consentDuration": "<string>",
              "required": false,
              "requireReacceptVersion": 123
            },
            "showGooglePrivacyPolicy": true
          },
          "gcmPolicy": "https://business.safety.google/privacy",
          "limitPii": false,
          "microsoftUET": "disabled"
        },
        "branding": {
          "buttonRadius": "6px",
          "cardRadius": "6px",
          "font": "Arial",
          "logoUrl": "<string>",
          "primaryColor": "<string>",
          "secondaryColor": "<string>",
          "poweredByConcord": true
        },
        "crossSiteTracking": false,
        "floatingButton": {
          "enabled": true,
          "circleOffsetX": "24px",
          "circleOffsetY": "24px",
          "tabOffsetY": "256px",
          "position": "right",
          "theme": "light",
          "type": "circle",
          "icon": "cookie"
        },
        "placeholders": {
          "enabled": true,
          "theme": "light"
        },
        "privacyCenter": {
          "consentHistory": true,
          "disclosures": true,
          "privacyRequests": true,
          "doNotSellRequests": true,
          "position": "right",
          "theme": "classic"
        }
      },
      "customScript": "<string>",
      "language": {
        "enabled": false,
        "defaultLanguage": "en_US"
      }
    }
  ],
  "regionTemplate": {
    "name": "<string>",
    "regions": "default",
    "customScript": "<string>",
    "settings": {
      "branding": {
        "buttonRadius": "<string>",
        "cardRadius": "<string>",
        "font": "<string>",
        "logoUrl": "<string>",
        "primaryColor": "<string>",
        "secondaryColor": "<string>",
        "poweredByConcord": true
      },
      "consent": {
        "blockingMode": "disabled",
        "consentMode": "implied",
        "consentBanner": {
          "enabled": true,
          "layout": "bar",
          "position": [
            "<unknown>"
          ],
          "policy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "title": true,
          "theme": "brand",
          "closeButton": true,
          "denyButton": true,
          "customizeButton": true,
          "showGooglePrivacyPolicy": true
        },
        "doNotSell": true,
        "consentDuration": 123,
        "gcm": "disabled",
        "gpc": true,
        "limitPii": true,
        "microsoftUET": "disabled"
      },
      "crossSiteTracking": true,
      "floatingButton": {
        "enabled": true,
        "circleOffsetX": "<string>",
        "circleOffsetY": "<string>",
        "tabOffsetY": "<string>",
        "position": "<string>",
        "theme": "brand",
        "type": "circle",
        "icon": "cookie"
      },
      "placeholders": {
        "enabled": true,
        "theme": "brand"
      },
      "privacyCenter": {
        "consentHistory": true,
        "disclosures": true,
        "privacyRequests": true,
        "doNotSellRequests": true,
        "position": "<string>",
        "theme": "brand"
      }
    },
    "language": {
      "enabled": true,
      "defaultLanguage": "<string>"
    }
  },
  "domains": [
    "localhost"
  ],
  "privacyPolicyUrl": "<string>",
  "termsOfServiceUrl": "<string>"
}
'
{
  "dateCreated": 123,
  "dateUpdated": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "settings": {
    "trackers": {
      "deepScan": false,
      "realTimeScan": false,
      "lastRealTimeScan": 123
    }
  },
  "slug": "<string>",
  "statusFlags": {
    "isActive": [
      "<unknown>"
    ],
    "isTest": [
      "<unknown>"
    ]
  },
  "type": "website",
  "default": [
    "<unknown>"
  ],
  "contactEmail": "[email protected]",
  "contactEmails": [
    "[email protected]"
  ],
  "mode": [
    "<unknown>"
  ],
  "organization": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "status": "<string>"
  },
  "sendFromEmailId": "default",
  "sendFromEmail": {
    "id": "default",
    "email": "[email protected]",
    "name": "<string>"
  },
  "status": "active"
}

Authorizations

x-api-key
string
header
required

Path Parameters

organizationId
string<uuid>
required

Body

application/json
name
string
required
Required string length: 2 - 1024
type
enum<string>
Available options:
website
contactEmails
string<email>[]
additionalRegions
object[]
regionTemplate
object
domains
(enum<string> | string)[]
Available options:
localhost,
127.0.0.1,
::1
privacyPolicyUrl
string
termsOfServiceUrl
string

Response

Default Response

dateCreated
integer
required
dateUpdated
integer
required
id
string<uuid>
required
name
string
required
Required string length: 2 - 1024
organizationId
string<uuid>
required
settings
object
required
slug
string
required
Maximum string length: 256
statusFlags
object
required
type
enum<string>
required
Available options:
website
default
contactEmail
string<email>
contactEmails
string<email>[]
mode
organization
object
sendFromEmailId
default:default
Available options:
default
sendFromEmail
object
status
enum<string>
Available options:
active,
test,
archived