--- title: "Create New Collection Point Version" method: POST path: "/api/consentmanager/v2/collectionpoints/{collectionPointGuid}/version" tags: ["Collection Points V2"] --- # Create New Collection Point Version `POST /api/consentmanager/v2/collectionpoints/{collectionPointGuid}/version` ## Request - Base URL: `https://hostname` - URL: `https://hostname/api/consentmanager/v2/collectionpoints/{collectionPointGuid}/version` - Auth: OAuth 2 - Client credentials - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `CONSENT` 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. ## Path parameters - `collectionPointGuid` string, uuid, required ## Response `200` Successfully created a new version of the Collection Point - ConsentPreferencesUniversalConsentPreferenceManagCollectionPointDtoV2 - `id` string, uuid: Unique identifier of the collection point - `version` integer: Version number of the collection point - `name` string: Name of the collection point - `status` 'DRAFT' | 'ACTIVE' | 'RETIRED' | 'INACTIVE' | 'DRAFT' | 'ACTIVE' | 'RETIRED' | 'INACTIVE': Current status of the collection point - `collectionPointType` 'WEB_FORM' | 'MOBILE_APPLICATION' | 'BULK_IMPORT' | 'API' | 'PREFERENCE_CENTER' | 'COOKIE' | 'TRUST_CENTER' | 'NOTIFICATION_OPT_OUT' | 'ADMIN_UPDATE' | 'HOSTED_WEB_FORM' | 'EMBEDDED_WEB_FORM' | 'WEB_FORM' | 'HOSTED_WEB_FORM' | 'EMBEDDED_WEB_FORM' | 'API': Type of the collection point - `consentType` 'FORMSUBMIT' | 'EXPLICIT' | 'UNAMBIGUOUS' | 'OPTINCHECKBOX' | 'OPTOUTCHECKBOX' | 'SINGLETRIGGER' | 'CONDITIONALTRIGGER' | 'COOKIEBANNER' | 'UNCHECKOPTOUT' | 'CHECKOPTOUT' | 'FORMSUBMIT' | 'IMPLICIT' | 'EXPLICIT': Type of consent mechanism used by the collection point - `description` string: Detailed description of the collection point's purpose - `subjectIdentifier` string: Identifier used to uniquely identify the data subject - `identifierDataElement` ConsentPreferencesUniversalConsentPreferenceManagCustomDataElementV2 - `guid` string, uuid, required: Unique identifier for the custom data element - `numberOfLanguages` integer: Number of language translations available for this data element - `createdDate` string, date-time: Timestamp when the data element was created - `lastModifiedDate` string, date-time: Timestamp when the data element was last modified - `canEdit` boolean: Indicates if the data element can be modified - `dataElementFields` ConsentPreferencesUniversalConsentPreferenceManagCustomDataElementField - `dataElementType` 'USER_INPUT' | 'SELECTION' | 'EMAIL' | 'NUMBER' | 'DATE_PICKER' | 'COUNTRY' | 'STATE' | 'COUNTRY_CODE' | 'PHONE_NUMBER' | 'STATE_CODE', required: The type of the custom data element (e.g., TEXT, NUMBER, DATE, etc.) - `displayAs` 'DROPDOWN' | 'NONE': Specifies how the data element should be displayed in the UI (e.g., as a text field, dropdown, radio buttons, etc.) - `dataElementOptions` ConsentPreferencesUniversalConsentPreferenceManagCustomDataElementOptionDtoV2[]: List of available options for this data element. Only applicable for choice-based elements like dropdowns or radio buttons. - `id` string, uuid - `label` string - `label` string, required: The display name/label of the custom data element - `isIdentifier` boolean: Indicates if this data element can be used as an identifier - `collectionPoints` integer: Number of collection points where this data element is being used - `languages` ConsentPreferencesUniversalConsentPreferenceManagDataElementLanguageDto[]: List of language-specific translations for this data element - `Name` string: The Data Element name - `DataElementOptions` ConsentPreferencesUniversalConsentPreferenceManagCustomDataElementOptionDto[]: List of options available for this data element in the specified language - `Id` string, uuid: Unique identifier for the custom data element option - `Label` string, required: Display text for the option - `Language` string: The Data Element translation language code - `createDate` string, date-time: Timestamp when the collection point was created - `firstReceiptOn` string, date-time: Timestamp when the first consent receipt was generated for this collection point - `receiptCount` integer: Total number of consent receipts generated from this collection point - `hostedWebFormId` string, uuid: Unique identifier of the hosted web form associated with this collection point - `webFormUrl` string, uri: URL where the collection point is hosted - `privacyPolicyUrl` string, uri: URL that redirects to the Privacy Policy - `activationDate` string, date-time: Timestamp when the collection point was activated - `organizationId` string, uuid: Unique identifier of the organization that owns this collection point - `doubleOptIn` boolean: Indicates if double opt-in (email confirmation) is required for this collection point - `redirectUrl` string, uri: URL to redirect to after double opt-in confirmation - `iabVendorId` integer: IAB Vendor ID for mobile collection points - `noConsentTransactions` boolean: Indicates if transactions without explicit consent should be recorded - `lastSdkIntegrationDate` string, date-time: Timestamp when the SDK integration was last updated - `language` string: Default language code for the collection point - `hostedSDK` boolean: Indicates if the settings are published to external storage for optimized performance - `showWarning` boolean - `sendConsentEmail` boolean: Indicates if a consent acknowledgement email should be sent - `responsibleUserId` string, uuid: Unique identifier of the user responsible for this collection point - `responsibleGroupId` string, uuid: Unique identifier of the group responsible for this collection point - `lastActivityDate` string, date-time: Timestamp of the most recent activity on this collection point - `warningReasons` string[]: Set of warning reasons associated with the collection point - `consentIntegration` boolean: Indicates if consent events should be sent to third-party integrations - `enableNewConsentIntegration` boolean: Indicates if the new consent integration is enabled - `isAuthenticationRequired` boolean: Indicates if authentication is required to access this collection point - `createdBy` string: Identifier of the user who created the collection point - `lastModifiedBy` string: Identifier of the user who last modified the collection point - `reconfirmActivePurpose` boolean: Indicates if reconsent is required for active purposes - `publishedBy` string: Identifier of the user who last published the collection point - `dataElements` string[]: List of data elements associated with the collection point - `jwtToken` object: JWT token data for authentication and authorization - `noticesWithVersions` ConsentPreferencesUniversalConsentPreferenceManagCollectionPointNoticeWithVersionDto[]: List of notices with their version information - `id` string, uuid, required: The unique identifier of the collection point notice. - `name` string, required: The name of the notice as it appears in the collection point. - `url` string, uri: The URL where the full notice content can be accessed, if applicable. - `privacyNoticeGuid` string, uuid, required: The unique identifier of the privacy notice this collection point notice is associated with. - `type` 'LINKED' | 'EMBEDDED', required: The type of the collection point notice, indicating its purpose or category. - `purposes` ConsentPreferencesUniversalConsentPreferenceManagSimpleNameVersion[], required: Set of purposes associated with this notice, including their names and versions. - `id` string, uuid, required: The unique identifier of the entity - `name` string, required: The display name of the entity - `version` integer, required: The version number of the entity - `type` string: The type of the entity (optional, used for categorization) - `privacyNoticeVersion` ConsentPreferencesUniversalConsentPreferenceManagPrivacyNoticeVersionDtoV2 - `id` string, uuid: Unique identifier of the privacy notice version - `name` string: Name of the privacy notice version - `version` integer: Major version number of the privacy notice - `minorVersion` integer: Minor version number of the privacy notice (used for patch versions) - `collectionPoint` ConsentPreferencesUniversalConsentPreferenceManagSimpleNameVersion - `id` string, uuid, required: The unique identifier of the entity - `name` string, required: The display name of the entity - `version` integer, required: The version number of the entity - `type` string: The type of the entity (optional, used for categorization) - `noticeType` 'PRIVACY_NOTICE' | 'DIGITAL_POLICY': The type of notice, which may provide additional categorization beyond the collection point notice type. - `canCreateNewVersion` boolean: Indicates if a new version of the collection point can be created - `newSdkIntegrationEnabled` boolean: Indicates if the new SDK integration is enabled - `disabled` boolean: Indicates if the collection point is disabled - `languages` string[]: List of language codes for which translations are availablel - `preferenceCenter` ConsentPreferencesUniversalConsentPreferenceManagPreferenceCenterSummaryDto - `Id` string, uuid: Unique Identifier identifying the Preference Center - `Name` string: The Preference Center name - `OrganizationName` string: The Organization's name - `Template` 'ORIGINAL' | 'ENHANCED' | 'MULTIPAGE': The Preference Center template type - `attributes` object: Additional attributes associated with the collection point - `purposes` ConsentPreferencesUniversalConsentPreferenceManagPurposeDetailDtoV2[]: The list of Purposes associated with the Collection Point. Each purpose contains detailed information including its status, consent model, and other relevant attributes. - `id` string, uuid, required: Unique identifier of the purpose - `label` string, required: Name or label of the purpose version - `description` string: Detailed description of the purpose version - `status` 'DRAFT' | 'ACTIVE' | 'RETIRED', required: Current status of the purpose version - `version` integer, required: Version number of the purpose - `consentLifeSpan` integer: Lifespan of consents recorded against this purpose version in seconds - `implicitConsentLifeSpan` integer: Lifespan of implicit consents recorded against this purpose version in seconds - `implicitConsentConfirmDesc` string: Description text for the implicit consent confirmation checkbox - `purposeType` 'STANDARD' | 'COOKIE' | 'IAB' | 'MOBILE' | 'NOTIFICATION_OPT_OUT', required: Type of the purpose - `parentPurposeId` string, uuid: Unique identifier of the parent purpose, if this is a child purpose - `retireOnDate` string, date-time: Date when the purpose will be retired - `createdBy` string: ID of the user who created the purpose - `createdDate` string, date-time: Date and time when the purpose version was created - `lastModifiedBy` string: ID of the user who last modified the purpose - `lastModifiedDate` string, date-time: Date and time when the purpose version was last modified - `publishedBy` string: ID of the user who published the purpose - `publishedDate` string, date-time: Date and time when the purpose version was published - `detail` string: URL to get the detailed information of this purpose version - `customPreferences` ConsentPreferencesUniversalConsentPreferenceManagPurposeCustomPreferenceDtoV2[]: List of custom preferences associated with the purpose - `id` string, required: Unique identifier of the purpose-custom preference relationship - `name` string, required: Name of the custom preference - `displayAs` 'BUTTONS' | 'CHECKBOXES', required: Display type for rendering the custom preference in the UI - `customPreferenceOptions` ConsentPreferencesUniversalConsentPreferenceManagCustomPreferenceOptionDtoV2[]: List of available options for this custom preference - `id` string - `transactionType` string - `label` string - `order` integer - `isDefault` boolean - `languages` ConsentPreferencesUniversalConsentPreferenceManagCustomPreferenceLanguageDtoV2[]: List of language-specific content for the custom preference - `name` string - `description` string - `language` string - `default` boolean - `options` ConsentPreferencesUniversalConsentPreferenceManagCustomPreferenceOptionDtoV2[] - `id` string - `transactionType` string - `label` string - `order` integer - `isDefault` boolean - `topics` ConsentPreferencesUniversalConsentPreferenceManagPurposeTopicDtoV2[]: List of topics associated with the purpose - `id` string, uuid, required: Unique identifier of the purpose-topic relationship - `transactionType` string: Type of transaction associated with the topic - `name` string, required: Name of the topic - `integrationKey` string: Integration key formed by combining purpose and topic names - `languages` ConsentPreferencesUniversalConsentPreferenceManagTopicLanguageDtoV2[]: List of language-specific content for the topic - `name` string - `language` string - `default` boolean - `canDelete` boolean: Indicates whether this topic can be deleted - `organizations` string[]: List of organization IDs associated with this purpose - `expiryDateType` 'LAST_TRANSACTION_DATE' | 'CONSENT_DATE': Type of date field used for calculating purpose lifespan/expiry - `enableGeolocation` boolean: Flag indicating whether to capture the data subject's geolocation when consent is provided - `attributes` object: Additional attributes attached to the purpose - `purposeLanguages` ConsentPreferencesUniversalConsentPreferenceManagPurposeLanguageDtoV3[]: List of language-specific purpose information - `name` string, required: The purpose name in the specified language - `description` string, required: The purpose description in the specified language - `implicitConsentConfirmDesc` string: Description text for the implicit consent confirmation checkbox in the specified language - `language` string: IETF BCP 47 language tag for the content - `default` boolean: Indicates if this is the default language for the purpose - `hardOptOutMessage` string: The message to display with the purpose when the consent status is Hard opt-out. This message only displays when hardOptOutDisplayFormat is set to LOCK. - `purposeId` integer, required: The unique identifier of the purpose this language entry belongs to - `LastMajorVersion` integer - `VersionNotes` string - `IsMajorVersion` boolean - `HardOptOutDisplayFormat` 'HIDE' | 'LOCK': The format in which the purpose displays in a Trust Center when the consent status is Hard opt-out. Hard opt-out purposes can either be displayed but locked, or hidden. - `HardOptOutMessage` string: The message to display with the purpose when the consent status is Hard opt-out. This message only displays when hardOptOutDisplayFormat is set to LOCK. - `languages` ConsentPreferencesUniversalConsentPreferenceManagPurposeLanguageDtoV2[]: List of languages supported by the purpose - `name` string, required: The purpose name in the specified language - `description` string, required: The purpose description in the specified language - `implicitConsentConfirmDesc` string: Description text for the implicit consent confirmation checkbox in the specified language - `language` string: IETF BCP 47 language tag for the content - `default` boolean: Indicates if this is the default language for the purpose - `hardOptOutMessage` string: The message to display with the purpose when the consent status is Hard opt-out. This message only displays when hardOptOutDisplayFormat is set to LOCK. - `receiptInclusionAttributes` object: Attributes that should be included in the receipt ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview). - `500`: Internal Server Error --- [API](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management.md) - [All operations](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management/revisions/fe4a0697ec9d?raw)