v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Collection Points V2

Create New Collection Point Version

Use this API to create a new version of an existing Collection Point that is currently in Active status. A new version of the Collection Point will be created in Draft status while the Active version of the Collection Point will remain unchanged.

🗒 Things to Know

Once the Collection Point is in Draft status, the Update Existing Collection Point API can be used to edit the Collection Point. Changes will only be visible once the new version of the Collection Point is published.

post/api/consentmanager/v2/collectionpoints/{collectionPointGuid}/version

Path parameters

collectionPointGuidstring uuid required

The unique identifier of the Collection Point to create a new version for

Response

Successfully created a new version of the Collection Point

idstring uuid

Unique identifier of the collection point

versioninteger

Version number of the collection point

namestring

Name of the collection point

Current status of the collection point

Type of the collection point

Type of consent mechanism used by the collection point

descriptionstring

Detailed description of the collection point's purpose

subjectIdentifierstring

Identifier used to uniquely identify the data subject

createDatestring date-time

Timestamp when the collection point was created

firstReceiptOnstring date-time

Timestamp when the first consent receipt was generated for this collection point

receiptCountinteger

Total number of consent receipts generated from this collection point

hostedWebFormIdstring uuid

Unique identifier of the hosted web form associated with this collection point

webFormUrlstring uri

URL where the collection point is hosted

privacyPolicyUrlstring uri

URL that redirects to the Privacy Policy

activationDatestring date-time

Timestamp when the collection point was activated

organizationIdstring uuid

Unique identifier of the organization that owns this collection point

doubleOptInboolean

Indicates if double opt-in (email confirmation) is required for this collection point

redirectUrlstring uri

URL to redirect to after double opt-in confirmation

iabVendorIdinteger

IAB Vendor ID for mobile collection points

noConsentTransactionsboolean

Indicates if transactions without explicit consent should be recorded

lastSdkIntegrationDatestring date-time

Timestamp when the SDK integration was last updated

languagestring

Default language code for the collection point

hostedSDKboolean

Indicates if the settings are published to external storage for optimized performance

showWarningboolean

sendConsentEmailboolean

Indicates if a consent acknowledgement email should be sent

responsibleUserIdstring uuid

Unique identifier of the user responsible for this collection point

responsibleGroupIdstring uuid

Unique identifier of the group responsible for this collection point

lastActivityDatestring date-time

Timestamp of the most recent activity on this collection point

warningReasonsstring[]

Set of warning reasons associated with the collection point

consentIntegrationboolean

Indicates if consent events should be sent to third-party integrations

enableNewConsentIntegrationboolean

Indicates if the new consent integration is enabled

isAuthenticationRequiredboolean

Indicates if authentication is required to access this collection point

createdBystring

Identifier of the user who created the collection point

lastModifiedBystring

Identifier of the user who last modified the collection point

reconfirmActivePurposeboolean

Indicates if reconsent is required for active purposes

publishedBystring

Identifier of the user who last published the collection point

dataElementsstring[]

List of data elements associated with the collection point

jwtTokenobject

JWT token data for authentication and authorization

canCreateNewVersionboolean

Indicates if a new version of the collection point can be created

newSdkIntegrationEnabledboolean

Indicates if the new SDK integration is enabled

disabledboolean

Indicates if the collection point is disabled

languagesstring[]

List of language codes for which translations are availablel

attributesobject

Additional attributes associated with the collection point

Example response

{
  "id": "25d9ccac-db88-4d34-849c-3d602a629961",
  "version": 2,
  "name": "Web Form Collection Point",
  "status": "ACTIVE",
  "collectionPointType": "WEB_FORM",
  "consentType": "FORMSUBMIT",
  "description": "Collecting data for Marketing and Promotion Purposes",
  "subjectIdentifier": "email",
  "identifierDataElement": {
    "guid": "21e0de87-d6ef-4b39-a54b-6d877698e3f6",
    "numberOfLanguages": 3,
    "createdDate": "2023-01-15T10:30:00Z",
    "lastModifiedDate": "2023-01-20T14:45:30Z",
    "canEdit": true,
    "label": "Work Email",
    "collectionPoints": 5,
    "languages": [
      {
        "Name": "Work Email",
        "DataElementOptions": [
          {
            "Id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
            "Label": "Option 1"
          }
        ],
        "Language": "en-us"
      }
    ]
  },
  "createDate": "2018-03-22T20:55:40.237Z",
  "firstReceiptOn": "2018-05-12T12:23:25.243Z",
  "receiptCount": 563,
  "hostedWebFormId": "123e4567-e89b-12d3-a456-426614174000",
  "webFormUrl": "https://www.onetrust.com/collection-point",
  "privacyPolicyUrl": "https://www.onetrust.com/privacy-notice",
  "activationDate": "2018-03-15T12:00:20.123Z",
  "organizationId": "92cf3a3a-09a9-4d04-b69d-ea5bb1db550a",
  "redirectUrl": "https://www.onetrust.com/thank-you",
  "iabVendorId": 13,
  "lastSdkIntegrationDate": "2020-01-08T14:25:11.112Z",
  "language": "en-us",
  "responsibleUserId": "bc4836e2-c117-461b-a7a2-2b268c037a97",
  "responsibleGroupId": "5466af43-ff42-4a39-8722-5a98e7981fc4",
  "lastActivityDate": "2020-01-10T18:12:13.543Z",
  "createdBy": "D452EC68-71C4-4935-9F17-5FD054365805",
  "lastModifiedBy": "304F7D36-75A2-4967-81A5-5A7D604C6A19",
  "publishedBy": "304F7D36-75A2-4967-81A5-5A7D604C6A19",
  "dataElements": [
    "First Name",
    "Last Name",
    "Email"
  ],
  "noticesWithVersions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Privacy Notice (v2.0)",
      "url": "https://example.com/privacy-notice",
      "privacyNoticeGuid": "223e4567-e89b-12d3-a456-426614174001",
      "purposes": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Marketing Consent Form",
          "version": 1,
          "type": "CONSENT_FORM"
        }
      ],
      "privacyNoticeVersion": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Privacy Policy v2.1",
        "version": 2,
        "minorVersion": 1
      },
      "collectionPoint": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Marketing Consent Form",
        "version": 1,
        "type": "CONSENT_FORM"
      }
    }
  ],
  "canCreateNewVersion": true,
  "languages": [
    "en-us",
    "fr"
  ],
  "preferenceCenter": {
    "Id": "09ccd1b9-84a0-4bcb-a167-f761391ebffa",
    "Name": "Email Communication Preferences",
    "OrganizationName": "OneTrust",
    "Template": "ENHANCED"
  },
  "purposes": [
    {
      "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "label": "Marketing Communications",
      "description": "Collect customer emails for marketing purposes",
      "status": "ACTIVE",
      "version": 2,
      "consentLifeSpan": 31536000,
      "implicitConsentLifeSpan": 31536000,
      "implicitConsentConfirmDesc": "I agree to the processing of my personal data for this purpose",
      "purposeType": "STANDARD",
      "parentPurposeId": "ba54eb25-90f0-4633-ab12-c7bf5afdd856",
      "retireOnDate": "2025-12-31T23:59:59Z",
      "createdBy": "304F7D36-75A2-4967-81A5-5A7D604C6A19",
      "createdDate": "2023-01-01T00:00:00Z",
      "lastModifiedBy": "304F7D36-75A2-4967-81A5-5A7D604C6A19",
      "lastModifiedDate": "2023-01-15T15:30:45Z",
      "publishedBy": "304F7D36-75A2-4967-81A5-5A7D604C6A19",
      "publishedDate": "2023-01-10T10:15:30Z",
      "detail": "https://app-eu.onetrust.com/api/consentmanager/v2/purposes/f2229953-b4b5-4042-8cb9-b78038cc4c46?version=2",
      "customPreferences": [
        {
          "id": "c4a57a38-3774-45ad-9fa4-dbc545542232",
          "name": "Email Frequency",
          "displayAs": "BUTTONS"
        }
      ],
      "topics": [
        {
          "id": "497c4383-2c61-4906-aed0-660e3fd03ef0",
          "transactionType": "OPT_IN",
          "name": "Car Marketing",
          "integrationKey": "Marketing-Communications_Car-Marketing",
          "canDelete": true
        }
      ],
      "organizations": [
        "f2229953-b4b5-4042-8cb9-b78038cc4c46",
        "bc4836e2-c117-461b-a7a2-2b268c037a97"
      ],
      "expiryDateType": "LAST_TRANSACTION_DATE",
      "enableGeolocation": true,
      "purposeLanguages": [
        {
          "name": "Marketing Communications",
          "description": "Collect customer emails for marketing purposes",
          "implicitConsentConfirmDesc": "I agree to the processing of my personal data for this purpose",
          "language": "en-US",
          "default": true,
          "hardOptOutMessage": "This purpose is required and cannot be opted out",
          "purposeId": 12345
        }
      ],
      "HardOptOutDisplayFormat": "HIDE",
      "HardOptOutMessage": "This purpose is required and cannot be opted out",
      "languages": [
        {
          "name": "Marketing Communications",
          "description": "Collect customer emails for marketing purposes",
          "implicitConsentConfirmDesc": "I agree to the processing of my personal data for this purpose",
          "language": "en-US",
          "default": true,
          "hardOptOutMessage": "This purpose is required and cannot be opted out"
        }
      ]
    }
  ]
}