Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Collection Points

Create Collection Point

Use this API to create a new Collection Point. The Collection Point will be created with version 1 and Draft status.

🗒 Things to Know

  • Data element name values support up to 750 characters. Data element types containing the word Country do not support the following characters: [<>();:'“$#}{]
  • If the EnablePrimaryIdentifier parameter is set to true, then the PrimaryIdentifierType parameter will be required in the API request body.
  • When creating a Web Form Collection Point, the HostedSDK parameter value will be set to true by default, regardless of the value entered in the request body.
  • One of the following parameters is required in the API request body: PurposeId, PurposeIds, or PurposeIdsWithVersion.
  • The PurposeId and PurposeIds parameters can be used to link an Active version of a purpose to a Collection Point.
  • The PurposeIdsWithVersion parameter can be used to link specific versions of a purpose (either in Draft or Active status) to a Collection Point.
post/api/consentmanager/v1/collectionpoints

Request body

OrganizationIdstring uuid required

The unique identifier of the Organization associated with the Collection Point. Note: this can be found in the URL path when viewing Organization details under global settings.

PurposeIdstring

Comma-separated list of Purpose unique identifiers. Will default to the most recent purpose version. It is recommended to use the PurposeIdsWithVersion field and specify the desired version.

PurposeIdsstring[]

List of Purpose unique identifiers. Will default to the most recent purpose version. It is recommended to use the PurposeIdsWithVersion field and specify the desired version.

Namestring required

The unique name of the Collection Point. This is a required field and must be unique within the organization. The name is used to identify the Collection Point in the UI and API.

Descriptionstring required

Detailed description of the Collection Point. This should explain the purpose and functionality of the Collection Point.

WebFormUrlstring uri

The URL where the web form is hosted. This is required for HOSTED_WEB_FORM collection points. The URL must be a valid HTTPS URL.

PrivacyPolicyUrlstring uri

The URL of the privacy policy associated with this Collection Point. This is typically displayed to users when they are providing consent.

SubjectIdentifierstring

The Data Subject identifier of the Collection Point. Note: this string is the Data Element name when viewing details under the Consent & Preference Management module

IdentifierTypesstring[]

Used in conjunction with the AllowMultipleIdentifierTypes setting. The List of Data Subject identifiers that can be used for the Collection Point

AllowMultipleIdentifierTypesboolean

Allow the Collection Point to generate data subjects with more than one identifier. Note: this feature is under preview for API and HOSTED_WEB_FORM Collection Points only

IdentifierDataElementIdstring uuid

Unique identifier for the Data Element. Note: this can be found in the url path when viewing Data Element details under the Consent & Preference Management module

ConsentType'FORMSUBMIT' | 'EXPLICIT' | 'UNAMBIGUOUS' | 'OPTINCHECKBOX' | 'OPTOUTCHECKBOX' | 'SINGLETRIGGER' | 'CONDITIONALTRIGGER' | 'COOKIEBANNER' | 'UNCHECKOPTOUT' | 'CHECKOPTOUT' | 'EXPLICIT' | 'IMPLIED' | 'NOTICE_ONLY' | 'CONSENT' | 'LEGITIMATE_INTEREST' | 'FORMSUBMIT' | 'UNAMBIGUOUS' | 'OPTINCHECKBOX' | 'OPTOUTCHECKBOX' | 'SINGLETRIGGER' | 'CONDITIONALTRIGGER' | 'COOKIEBANNER' | 'UNCHECKOPTOUT' | 'CHECKOPTOUT'

The type of consent mechanism used by this Collection Point. This determines how consent is captured and processed. For example, EXPLICIT requires explicit user action, while IMPLIED infers consent from user behavior.

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' | 'API' | 'COOKIE' | 'NOTIFICATION_OPT_OUT' | 'ADMIN_UPDATE' required

The type of the Collection Point. This determines the behavior and features available for the Collection Point. For example, WEB_FORM is used for web-based consent banners, while API is used for programmatic consent management.

DataControllerNamestring

The name of the data controller responsible for this Collection Point. This is typically the organization or entity that determines the purposes and means of processing personal data.

RightToWithdrawstring

Information about the data subject's right to withdraw consent. This is typically displayed to users to inform them of their rights.

HowToWithdrawstring

Instructions on how a data subject can withdraw their consent. This should provide clear, actionable steps.

OtherInformationstring

Any additional information relevant to the Collection Point that doesn't fit in other fields. This could include legal basis for processing or other compliance-related information.

DoubleOptInboolean

Indicates whether double opt-in is required for this Collection Point. When enabled, users must confirm their consent via email.

DOISendConfirmationEmailboolean

Double Opt In child setting to send the confirmation email or not. Note: the confirmation link is included in the Data Subject Profile Updated integrations event, which can be used to send custom email or sms messages

DoiEmailToParentboolean

When enabling the parental consent feature and double opt-in emails, emails will be sent to the parent identifier by default instead of the child identifier. This is part of the parental consent preview feature.

consentDOICancelOptionboolean

When enabled, allows sending a cancellation notice for double opt-in (DOI) consent. This is used when a user cancels their consent during the double opt-in process.

includeParameterboolean

When enabled, includes additional parameters in the double opt-in (DOI) confirmation link. This can be used to pass through custom parameters during the DOI process.

RedirectUrlstring uri

The URL to redirect users to after they have completed the consent process. This is typically a thank you page or the main website.

IABVendorIdinteger

The IAB Vendor Id. Used for legacy mobile Collection Points

DataElementsstring[]

List of data element IDs that this Collection Point will collect consent for. Each data element represents a specific type of data processing activity.

Languagestring

The Collection Point default language code

Languagesstring[]

List containing the Collection Point translations' language codes

NoConsentTransactionsboolean

Whether no consent transactions can be recorded against the collection point. For more information about consent transaction types and purpose statuses see this article

HostedSDKboolean

Whether the SDK settings are published to external storage for quicker integration. This is enabled by default for all web form type collection points

SendConsentEmailboolean

Switch on or off the Consent Acknowledgement Email feature for a Collection Point

PreferenceCenterGuidstring uuid

Unique identifier for a Preference Center to associate with this Collection Point

ResponsibleUserIdstring uuid

The Unique Identifier of the Responsible User. Note: this can be found in the url path when viewing Responsible User details under global settings

ResponsibleGroupIdstring uuid

The Unique Identifier of the Responsible Group. Note: this can be found in the url path when viewing Responsible Group details under global settings

ConsentIntegrationboolean

Setting to fire the Data Subject Consent Updated integrations event. Note: we recommend using the EnableNewConsentIntegration setting to fire the Data Subject Profile Updated event instead

EnableNewConsentIntegrationboolean

Setting to fire the Data Subject Profile Updated integrations event. Note: ConsentIntegration must be enabled (true) in order for EnableNewConsentIntegration to take effect. For more information see this article

IsAuthenticationRequiredboolean

Setting to require authentication for a collection point. For more information see this article

ReconfirmActivePurposeboolean

Used in conjunction with the double opt in feature. Will treat a returning data subject the same as a new one, and trigger the confirmation email event when re-consenting to the same purpose

OverrideActivePurposeboolean

Used in conjunction with the double opt in reconfirmation and purpose expiration features. This setting is enabled by default and can be turned off if it is desired for a purpose to remain in active status until expired if a data subject does not reconfirm their consent

IsDynamicCollectionPointboolean

Whether this is a dynamic collection point or not. For more information see this article

NewSdkIntegrationEnabledboolean

Whether new sdk integration is enabled or not. SDK can be loaded in the <head> and a new script is no longer required for each form

attributeValuesobject

A map of attribute names to their corresponding values and metadata. Used for storing custom attributes associated with the Collection Point.

includeIdentifierParameterboolean

When enabled, includes the identifier parameter in the double opt-in (DOI) confirmation link. This is useful for passing the identifier through the DOI process.

EnablePublishEventboolean

Setting to fire the Collection Point Published integrations event. For more information see this article

EnablePrimaryIdentifierboolean

Setting to enable primary identifier functionality. When enabled, designates one of the identifiers as the primary identifier for the data subject.

EnableCaptchaboolean

When enabled, requires users to complete a CAPTCHA challenge before submitting the form. This helps prevent automated submissions and spam.

PrimaryIdentifierTypestring

The primary identifier type used to identify data subjects for this Collection Point. This is used when multiple identifier types are configured.

CookieConsentUpdate'UPDATE_ALL' | 'SKIP_TRANSACTION'

Specifies how cookie consent updates should be handled for this Collection Point. This determines the behavior when consent preferences change.

EnableGeolocationboolean

When enabled, captures the data subject's geolocation (with their consent) for specific purposes. This feature is currently in preview.

EnablePrefillIdentifierboolean

When enabled, allows the Collection Point to pre-fill identifier fields when possible, improving user experience for returning visitors.

EnableGeoLocationForDataElementsboolean

When enabled, captures the data subject's geolocation (with their consent) for specific data elements. This feature is currently in preview.

RedirectOnFormSubmissionboolean

When enabled, automatically redirects users to a specified URL after they submit the form. The redirect URL can be configured separately.

DisableReportsboolean

When set to true, disables all reporting for this Collection Point. This can be used to improve performance for high-volume Collection Points where reporting is not needed.

ParentIdentifierTypesstring[]

List of parent data subject identifier types for this Collection Point. Used with Consent on Behalf and Multiple Data Subject Identifiers features.

DOIEmailIdentifierstring

The email address to use when sending double opt-in confirmation emails. If not specified, the primary email identifier will be used.

AckEmailIdentifierstring

The email address to use when sending acknowledgment emails. This can be different from the main contact email for the Collection Point.

PrefillIdentifierstring

The identifier value to pre-fill in the form when known. This improves user experience by reducing data entry for returning visitors.

enablePurposeEventboolean

When enabled, generates an event whenever a purpose-related action occurs through this Collection Point. Useful for triggering workflows or integrations.

enableDataElementEventboolean

When enabled, generates an event whenever a data element-related action occurs through this Collection Point. Useful for triggering workflows or integrations.

enableCustomPreferenceEventboolean

When enabled, generates an event for custom preference changes made through this Collection Point. Useful for triggering workflows or integrations.

Example request

{
  "OrganizationId": "92cf3a3a-09a9-4d04-b69d-ea5bb1db550a",
  "PurposeId": "f2229953-b4b5-4042-8cb9-b78038cc4c46,a6d68a29-a185-40e8-ac4c-5656d4856b0a",
  "PurposeIds": [
    "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "a6d68a29-a185-40e8-ac4c-5656d4856b0a"
  ],
  "Name": "Website Consent Banner",
  "Description": "This collection point is used to collect consent for marketing cookies on the main website.",
  "WebFormUrl": "https://example.com/consent-form",
  "PrivacyPolicyUrl": "https://example.com/privacy-policy",
  "SubjectIdentifier": "Email",
  "IdentifierDataElementId": "7912bfe1-37dd-4180-8b99-963e80f3e125",
  "ConsentType": "EXPLICIT",
  "CollectionPointType": "WEB_FORM",
  "DataControllerName": "Acme Corp",
  "RightToWithdraw": "You have the right to withdraw your consent at any time.",
  "HowToWithdraw": "To withdraw your consent, please contact our Data Protection Officer at dpo@example.com.",
  "OtherInformation": "Processing is necessary for the performance of a contract to which the data subject is party.",
  "RedirectUrl": "https://example.com/thank-you",
  "IABVendorId": 13,
  "DataElements": [
    "marketing",
    "analytics",
    "preferences"
  ],
  "Language": "en-us",
  "PreferenceCenterGuid": "09ccd1b9-84a0-4bcb-a167-f761391ebffa",
  "ResponsibleUserId": "bc4836e2-c117-461b-a7a2-2b268c037a97",
  "ResponsibleGroupId": "5466af43-ff42-4a39-8722-5a98e7981fc4",
  "OverrideActivePurpose": true,
  "attributeValues": {
    "customField1": [
      {
        "value": "example",
        "dataType": "string"
      }
    ]
  },
  "HostedWebForm": {
    "Id": "123e4567-e89b-12d3-a456-426614174000",
    "Name": "Main Consent Form",
    "SdkVersion": "1.0.0",
    "PublishedLink": "https://example.com/consent-form/published",
    "DraftLink": "https://example.com/consent-form/draft",
    "VersionId": "b6e376c3-e838-439f-a01b-1af24cf9a5ac",
    "DefaultLanguageTranslations": {
      "en": "English",
      "es": "Spanish"
    },
    "PortalData": {
      "DefaultLanguage": "en",
      "SelectedLanguage": [
        "en",
        "es",
        "fr"
      ],
      "CustomTranslations": {
        "es": {
          "welcome.message": "Bienvenido"
        },
        "fr": {
          "welcome.message": "Bienvenue"
        }
      }
    },
    "TestScriptGuid": "65840dad-c063-48d1-82e0-b9ec79f27908",
    "ProdScriptGuid": "2defe229-42b9-4a16-85be-7e9610240d31",
    "previewId": "f7cd1221-04a1-4523-89bf-3430c91b5cc9",
    "TestPublishVersion": "1.0.0",
    "ProdPublishVersion": "1.0.1",
    "supportedScriptVersion": [
      "1.0.0",
      "2.0.0"
    ],
    "NewSelectedLanguages": [
      "en",
      "es",
      "fr"
    ],
    "IntegrationUrls": [
      "https://example.com/integration1",
      "https://example.com/integration2"
    ],
    "IntegrationSettings": {
      "analytics": {
        "enabled": true
      },
      "crm": {
        "enabled": false
      }
    },
    "formTemplate": "default-template"
  },
  "PurposeIdsWithVersion": [
    {
      "id": "7912bfe1-37dd-4180-8b99-963e80f3e125",
      "version": 1
    }
  ],
  "PrimaryIdentifierType": "Email",
  "CookieConsentUpdate": "UPDATE_ALL",
  "ParentIdentifierTypes": [
    "Email",
    "Mobile"
  ],
  "DOIEmailIdentifier": "user@example.com",
  "AckEmailIdentifier": "acknowledgment@example.com",
  "PrefillIdentifier": "user@example.com"
}

Response

Collection Point created successfully

jwtTokenstring

This property always returns null. To fetch the collection point's token, use the Get collection point token API.

Idstring uuid

Unique Identifier of the Collection Point

Versioninteger

Version of the Collection Point

Namestring

Name 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'

Type of the Collection Point

ConsentType'FORMSUBMIT' | 'EXPLICIT' | 'UNAMBIGUOUS' | 'OPTINCHECKBOX' | 'OPTOUTCHECKBOX' | 'SINGLETRIGGER' | 'CONDITIONALTRIGGER' | 'COOKIEBANNER' | 'UNCHECKOPTOUT' | 'CHECKOPTOUT'

Consent type of the Collection Point

Status'DRAFT' | 'ACTIVE' | 'RETIRED' | 'INACTIVE'

Status of the Collection Point

SubjectIdentifierstring

The Data Subject identifier of the Collection Point. Note: this string is the Data Element name when viewing details under the Consent & Preference Management module

CreateDatestring date-time

Created Date of the Collection Point

FirstReceiptOnstring date-time

Date the first consent receipt was generated on for the Collection Point

ReceiptCountinteger

Number of consent receipts issued from this Collection Point

Descriptionstring

Description of the Collection Point

WebFormUrlstring

URL on which the Collection Point is hosted

PrivacyPolicyUrlstring

URL that redirects to a Privacy Policy associated with this Collection Point

ActivationDatestring date-time

The Collection Point activation date

OrganizationIdstring uuid

The unique Identifier of the Organization associated with the Collection Point. Note: this can be found in the url path when viewing Organization details under global settings

DoubleOptInboolean

Whether Double Opt In (email confirmation) is enabled or not

RedirectUrlstring

Used in Double Opt In confirmation email to redirect the Data Subject to another website after confirming their consent

IABVendorIdinteger

The IAB Vendor Id. Used for legacy mobile Collection Points

NoConsentTransactionsboolean

Whether no consent transactions can be recorded against the collection point. For more information about consent transaction types and purpose statuses see this article

LastSdkIntegrationDatestring date-time

The date that the SDK Integration was last copied on

Languagestring

The Collection Point default language code

Languagesstring[]

List containing the Collection Point translations' language codes

HostedSDKboolean

Whether the SDK settings are published to external storage for quicker integration. This is enabled by default for all web form type collection points

SendConsentEmailboolean

Switch on or off the Consent Acknowledgement Email feature for a Collection Point

ResponsibleUserIdstring uuid

The Unique Identifier of the Responsible User. Note: this can be found in the url path when viewing Responsible User details under global settings

ResponsibleGroupIdstring uuid

The Unique Identifier of the Responsible Group. Note: this can be found in the url path when viewing Responsible Group details under global settings

LastActivityDatestring date-time

Date on which the latest activity was recorded

ConsentIntegrationboolean

Setting to fire the Data Subject Consent Updated integrations event. Note: we recommend using the EnableNewConsentIntegration setting to fire the Data Subject Profile Updated event instead

EnableNewConsentIntegrationboolean

Setting to fire the Data Subject Profile Updated integrations event. For more information see this article

IsAuthenticationRequiredboolean

Setting to require authentication for a collection point. For more information see this article

CreatedBystring
LastModifiedBystring

Id of the user who last updated collection point

ReconfirmActivePurposeboolean

Used in conjunction with the double opt in feature. Will treat a returning data subject the same as a new one, and trigger the confirmation email event when re-consenting to the same purpose

OverrideActivePurposeboolean

Used in conjunction with the double opt in reconfirmation and purpose expiration features. This setting is enabled by default and can be turned off if it is desired for a purpose to remain in active status until expired if a data subject does not reconfirm their consent

PublishedBystring

Id of the user who last published the collection point

IsDynamicCollectionPointboolean

Whether this is a dynamic collection point or not. For more information see this article

DoiEmailToParentboolean

When enabling the parental consent feature and double opt in emails, emails will be sent to the parent identifier by default instead of the child identifier. For more information about this preview feature see this [article](https://my.onetrust.com/s/article/UUID-f247abdd-fc02-413f-f5b8-17bff9dca4fa?topicId=0TO1Q000000ItSSWA0

NewSdkIntegrationEnabledboolean

Whether new sdk integration is enabled or not. SDK can be loaded in the <head> and a new script is no longer required for each form

consentDOICancelOptionboolean

Setting for sending a cancellation for DOI CP

DOISendConfirmationEmailboolean

Double Opt In child setting to send the confirmation email or not. Note: the confirmation link is included in the Data Subject Profile Updated integrations event, which can be used to send custom email or sms messages

Disabledboolean

Whether this collection point is disabled or not

EnablePublishEventboolean

Setting to fire the Collection Point Published integrations event. For more information see this article

EnablePrimaryIdentifierboolean

Setting to enable primary identifier

EnableCaptchaboolean

Setting to enable captcha

PrimaryIdentifierTypestring

The primary Data Subject identifier type of the Collection Point

EnableGeolocationboolean

Setting to capture Data Subject's geolocation if they provide consent with a specific purpose. Note the geolocation feature is currently under preview

EnableGeoLocationForDataElementsboolean

Setting to capture Data Subject's geolocation if they provide consent with a specific data element. Note the geolocation feature is currently under preview

EnablePrefillIdentifierboolean

Setting to capture whether to remember identifier in portal side

RedirectOnFormSubmissionboolean

Setting to enable/disable the redirection feature on form submission

DisableReportsboolean

Setting to stop consent Data Subject report for this CollectionPoint

enablePurposeEventboolean

Setting to enable delta events for purposes in this CollectionPoint

enableDataElementEventboolean

Setting to enable delta events for data elements in this CollectionPoint

enableCustomPreferenceEventboolean

Setting to enable delta events for custom preference in this CollectionPoint

DataElementsstring[]

List containing the Data Elements associated with the Collection Point

IdentifierTypesstring[]

Used in conjunction with the AllowMultipleIdentifierTypes setting. The List of Data Subject identifiers that can be used for the Collection Point

AllowMultipleIdentifierTypesboolean

Allow list of Data Subject identifier types for the Collection Point

DataElementsTranslationobject

Data Element Translation

CanCreateNewVersionboolean

Whether a new version of the collection point can be created or not

attributesobject

Attributes attached to the collection point

includeParameterboolean

Setting to include parameter for DOI CP

includeIdentifierParameterboolean

Setting to include Identifier parameter for DOI CP

CookieConsentUpdate'UPDATE_ALL' | 'SKIP_TRANSACTION'

Setting that governs cookie consent updates

ParentIdentifierTypesstring[]

The List of parent Data Subject identifier types for the Collection Point. Note: this setting is used with the Consent on Behalf and Multiple Data Subject Identifiers preview features"

DOIEmailIdentifierstring

Email identifier for which DOI needs to be sent

AckEmailIdentifierstring

Identifier for which acknowledgement email needs to be sent

PrefillIdentifierstring

Identifier which needs to be prefilled

ShowDLNotificationboolean

Setting to indicate whether to show data localization URL change notification for this collection point

Example response

{
  "jwtToken": "null",
  "noticesWithVersions": [
    "id",
    "name",
    "privacyNoticeGuid"
  ],
  "Id": "25d9ccac-db88-4d34-849c-3d602a629961",
  "Version": 2,
  "Name": "Web Form Collection Point",
  "CollectionPointType": "WEB_FORM",
  "ConsentType": "FORMSUBMIT",
  "Status": "ACTIVE",
  "SubjectIdentifier": "Email",
  "IdentifierDataElement": {
    "Id": "21e0de87-d6ef-4b39-a54b-6d877698e3f6",
    "Label": "Work Email",
    "Languages": [
      {
        "Name": "Work Email",
        "DataElementOptions": [
          {
            "Id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
            "Label": "Option 1"
          }
        ],
        "Language": "en-us"
      }
    ],
    "NumberOfLanguages": 3,
    "CreatedDate": "2019-12-30T10:52:30.974Z",
    "UpdatedDate": "2019-12-30T10:55:30.974Z",
    "CollectionPoints": 2,
    "CollectionPointsWithoutRetired": 2,
    "totalActivePreferenceCenters": 2,
    "PreferenceCenters": 2,
    "Organizations": [
      "712a1f61-a548-432f-afc4-5a383c28eeb2",
      "862a1f61-e148-032f-afc4-7a383c28eec6"
    ]
  },
  "ReceiptCount": 563,
  "Description": "Collecting data for Marketing and Promotion Purposes",
  "WebFormUrl": "https://www.onetrust.com/",
  "PrivacyPolicyUrl": "https://www.onetrust.com/privacy-notice",
  "OrganizationId": "92cf3a3a-09a9-4d04-b69d-ea5bb1db550a",
  "RedirectUrl": "https://www.onetrust.com/",
  "IABVendorId": 13,
  "Language": "en-us",
  "Languages": [
    "en-us",
    "fr"
  ],
  "PreferenceCenter": {
    "Id": "09ccd1b9-84a0-4bcb-a167-f761391ebffa",
    "Name": "Email Communication Preferences",
    "OrganizationName": "OneTrust",
    "Template": "ENHANCED"
  },
  "ResponsibleUserId": "bc4836e2-c117-461b-a7a2-2b268c037a97",
  "ResponsibleGroupId": "5466af43-ff42-4a39-8722-5a98e7981fc4",
  "LastModifiedBy": "304F7D36-75A2-4967-81A5-5A7D604C6A19",
  "PublishedBy": "304F7D36-75A2-4967-81A5-5A7D604C6A19",
  "PrimaryIdentifierType": "Email",
  "EnableGeolocation": true,
  "EnableGeoLocationForDataElements": true,
  "EnablePrefillIdentifier": true,
  "RedirectOnFormSubmission": true,
  "DisableReports": true,
  "enablePurposeEvent": true,
  "enableDataElementEvent": true,
  "enableCustomPreferenceEvent": true,
  "DataElements": [
    "First Name",
    "Last Name",
    "Work Email"
  ],
  "IdentifierTypes": [
    "Email",
    "Mobile"
  ],
  "AllowMultipleIdentifierTypes": true,
  "CanCreateNewVersion": true,
  "HostedWebForm": {
    "Id": "123e4567-e89b-12d3-a456-426614174000",
    "Name": "Main Consent Form",
    "SdkVersion": "1.0.0",
    "PublishedLink": "https://example.com/consent-form/published",
    "DraftLink": "https://example.com/consent-form/draft",
    "VersionId": "b6e376c3-e838-439f-a01b-1af24cf9a5ac",
    "DefaultLanguageTranslations": {
      "en": "English",
      "es": "Spanish"
    },
    "PortalData": {
      "DefaultLanguage": "en",
      "SelectedLanguage": [
        "en",
        "es",
        "fr"
      ],
      "CustomTranslations": {
        "es": {
          "welcome.message": "Bienvenido"
        },
        "fr": {
          "welcome.message": "Bienvenue"
        }
      }
    },
    "TestScriptGuid": "65840dad-c063-48d1-82e0-b9ec79f27908",
    "ProdScriptGuid": "2defe229-42b9-4a16-85be-7e9610240d31",
    "previewId": "f7cd1221-04a1-4523-89bf-3430c91b5cc9",
    "TestPublishVersion": "1.0.0",
    "ProdPublishVersion": "1.0.1",
    "supportedScriptVersion": [
      "1.0.0",
      "2.0.0"
    ],
    "NewSelectedLanguages": [
      "en",
      "es",
      "fr"
    ],
    "IntegrationUrls": [
      "https://example.com/integration1",
      "https://example.com/integration2"
    ],
    "IntegrationSettings": {
      "analytics": {
        "enabled": true
      },
      "crm": {
        "enabled": false
      }
    },
    "formTemplate": "default-template"
  },
  "CookieConsentUpdate": "SKIP_TRANSACTION, UPDATE_ALL",
  "ParentIdentifierTypes": [
    "First Name",
    "Last Name",
    "Address"
  ],
  "DOIEmailIdentifier": "test@ot.com",
  "AckEmailIdentifier": "testack@ot.com",
  "PrefillIdentifier": "randomId",
  "Purposes": [
    {
      "Id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "Label": "Marketing Communications",
      "Description": "Collect customer emails for marketing purposes",
      "Status": "ACTIVE",
      "NewVersionAvailable": true,
      "Type": "STANDARD",
      "LifeSpan": 7889238,
      "ImplicitConsentConfirmDesc": "I can confirm",
      "PurposeCategory": {
        "id": "a34ccec7-1ec0-4d65-9075-bdd0d923f1d1",
        "value": "Text Value",
        "valueKey": "attribute.option.valueKey",
        "colorCode": "red",
        "optionSelectionValue": "\"3.5\"",
        "displayLabel": "United State | San Francisco",
        "associatedAttributeValueInformation": [
          {
            "id": "a34ccec7-1ec0-4d65-9075-bdd0d923f1d1",
            "value": "Text Value",
            "valueKey": "attribute.option.valueKey",
            "colorCode": "red"
          }
        ]
      },
      "Version": 2,
      "ParentPurposeId": "ba54eb25-90f0-4633-ab12-c7bf5afdd856",
      "includeParameter": "false",
      "CreatedDate": "2019-12-30T10:52:30.974Z",
      "UpdatedBy": "304F7D36-75A2-4967-81A5-5A7D604C6A19",
      "UpdatedDate": "2019-12-30T10:54:30.974Z",
      "PublishedBy": "304F7D36-75A2-4967-81A5-5A7D604C6A19",
      "PublishedDate": "2019-12-30T10:54:30.974Z",
      "Topics": [
        {
          "Id": "497c4383-2c61-4906-aed0-660e3fd03ef0",
          "Name": "Car Marketing",
          "IntegrationKey": "Marketing-Communications_Car-Marketing",
          "CanDelete": true
        }
      ],
      "CustomPreferences": [
        {
          "Id": "194e0d3b-0ba8-4bc7-b046-e3ae42b2bd25",
          "Name": "Email Frequency",
          "Description": "Options for different frequencies to receive emails",
          "SelectionType": "SINGLE_CHOICE",
          "DisplayAs": "BUTTONs",
          "CreatedDate": "2023-01-15T10:52:30.974Z",
          "UpdatedDate": "2023-01-15T10:55:30.974Z",
          "NumberOfOptions": 4,
          "NumberOfLanguages": 3,
          "DefaultLanguage": "en-us",
          "Options": [
            {
              "Id": "ca0fc41b-b28a-4335-804c-44d1f0f782ed",
              "Label": "Weekly",
              "Order": 1,
              "IsDefault": true,
              "CanDelete": true
            }
          ],
          "Languages": [
            {
              "Name": "Email Frequency",
              "Description": "Options for different frequencies to receive emails",
              "Language": "en-us",
              "Default": true,
              "Options": [
                {
                  "Id": "ca0fc41b-b28a-4335-804c-44d1f0f782ed",
                  "Label": "Weekly",
                  "Order": 1,
                  "IsDefault": true,
                  "CanDelete": true
                }
              ]
            }
          ],
          "Organizations": [
            "712a1f61-a548-432f-afc4-5a383c28eeb2"
          ],
          "TotalLinkedActivePurposes": 5,
          "PurposeCustomPreferenceId": "c4a57a38-3774-45ad-9fa4-dbc545542232"
        }
      ],
      "PurposeLanguages": [
        {
          "Name": "Marketing Communications",
          "Description": "Collect customer emails for marketing purposes",
          "Description of Implicit Purpose Confirmation checkbox": "I can confirm",
          "Language": "en-us",
          "Default": true,
          "HardOptOutMessage": "This purpose is required and cannot be opted out"
        }
      ],
      "EnableGeolocation": true,
      "LastMajorVersion": 5,
      "VersionNotes": "Added new consent options",
      "IsMajorVersion": true,
      "HardOptOutDisplayFormat": "HIDE",
      "HardOptOutMessage": "This purpose is required and cannot be opted out"
    }
  ]
}