Consent types

Create consent type

Create a new consent type in a project.

POST
/organizations/{organizationId}/projects/{projectId}/consent-types
x-api-key<token>

In: header

Path Parameters

organizationIdstring
Formatuuid
projectIdstring
Formatuuid
categorystring
Value in"disclosure" | "communication" | "privacy_setting" | "custom"
subcategorystring
Value in"analytics" | "do_not_sell" | "functional" | "global_privacy_control" | "limit_pii_use" | "marketing" | "strictly_necessary" | "unclassified" | "email" | "phone" | "privacy_policy" | "terms_of_service" | "cookie_policy" | "data_protection_agreement"
labelstring
Match[a-z0-9_*]{1,128}$
Lengthlength <= 128
name?string
Length5 <= length <= 100
description?string
Lengthlength <= 2000
document?string
Lengthlength <= 5000000
url?string
Formaturi
validStates?array<string>
consentDuration?string
Formatduration
status?string
Default"active"
Value in"active" | "test" | "archived"
required?boolean
Defaultfalse
requireReaccept?boolean
Defaultfalse

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.concord.tech/privacy-v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/consent-types" \  -H "Content-Type: application/json" \  -d '{    "category": "disclosure",    "subcategory": "privacy_policy",    "label": "string"  }'
{
  "createdAt": [
    null
  ],
  "updatedAt": [
    null
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  "category": "disclosure",
  "subcategory": "privacy_policy",
  "label": "string",
  "version": 0,
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "document": "string",
  "url": "http://example.com",
  "readOnly": false,
  "validStates": [
    "implied"
  ],
  "status": "active",
  "consentDuration": "string",
  "required": false,
  "requireReacceptVersion": 0
}
{
  "statusCode": 404,
  "error": "Not Found",
  "message": "string"
}
{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Forbidden"
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Forbidden"
}
{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Not Found"
}
{
  "statusCode": 422,
  "error": "Unprocessable Entity",
  "message": "string"
}
{
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "Internal Server Error"
}