v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Collection Points

Update Existing Collection Point

Use this API to update an existing Collection Point. Before calling this API, ensure that the Collection Point is in Draft status. If the Collection Point is in Active status, use the Create New Collection Point Version API to create a new version of the Collection Point.

🗒 Things to Know

One of the following parameters must be included 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.

put/api/consentmanager/v1/collectionpoints/{collectionpointId}

Path parameters

collectionpointIdstring uuid required

Example:123e4567-e89b-12d3-a456-426614174000

The unique identifier of the Collection Point to update.

Query parameters

versioninteger

Example:1

The version of the Collection Point to update. If not provided, version 1 will be used.

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

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.

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 values associated with this Collection Point.

This field allows for custom attributes to be attached to the Collection Point for additional metadata or integration purposes. The key represents the attribute name, and the value is a list of attribute value information objects.

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.

The current status of the Collection Point.

This field determines whether the Collection Point is active, inactive, or in another state. Only active Collection Points will be served to end users.

PreferenceCenterSettingsobject

A key-value map containing all Preference Center settings for this Collection Point.

These settings control the appearance and behavior of the Preference Center associated with this Collection Point. The structure of this object depends on the specific configuration of the Preference Center.

PortalSettingsobject

A key-value map containing all Portal settings for this Collection Point.

These settings control the appearance and behavior of the Privacy Portal associated with this Collection Point. The structure of this object depends on the specific configuration of the Portal.

LastSdkIntegrationDatestring date-time

The timestamp when the SDK integration was last synchronized with this Collection Point.

This field is automatically updated by the system when changes are made to the Collection Point that require SDK updates. It should not be set manually.

HostedWebformPublishboolean

Flag indicating whether to publish the hosted webform for this Collection Point.

When set to true, the webform will be published and made available at the configured URL. When set to false, the webform will be unpublished but the configuration will be saved.

Note: This field is only applicable for Collection Points with collectionPointType set to HOSTED_WEB_FORM.

doNotActivateWebformboolean required

When set to true, prevents the embedded webform from being automatically activated.

This is useful when you want to configure the webform but activate it at a later time. The webform will remain in a draft state until explicitly activated.

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,
  "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",
  "Status": "ACTIVE",
  "PreferenceCenterSettings": {
    "theme": {
      "primaryColor": "#007bff"
    },
    "features": {
      "saveButton": true
    }
  },
  "PortalSettings": {
    "showBanner": true,
    "consentPurposes": [
      "analytics",
      "marketing"
    ]
  },
  "LastSdkIntegrationDate": "2023-01-15T10:30:00Z",
  "Notices": [
    {
      "name": "Marketing Preferences Notice",
      "url": "https://example.com/privacy-notice",
      "privacyNoticeGuid": "123e4567-e89b-12d3-a456-426614174000",
      "type": "PRIVACY_NOTICE",
      "purposeId": "123e4567-e89b-12d3-a456-426614174000",
      "purposeIds": [
        "123e4567-e89b-12d3-a456-426614174000",
        "223e4567-e89b-12d3-a456-426614174001"
      ],
      "noticeType": "PRIVACY_NOTICE"
    }
  ],
  "HostedWebformPublish": true,
  "doubleOptInExcludedPurposes": [
    {
      "purposeGuid": "123e4567-e89b-12d3-a456-426614174000",
      "excludeFromDoubleOptIn": true
    }
  ]
}

v1

Update Existing Collection Point

Path parameters

Query parameters

Request body

Example request

Response