myOneTrustDeveloper ForumTechnology Partners
API Reference
Subscribe via RSS
Start typing to searchโ€ฆ

Create Collection Point

post
https://{hostname}/api/consentmanager/v1/collectionpoints

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.
Body Params
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.

string

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.

PurposeIds
array of uuids

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.

PurposeIds
string
required
length between 1 and 255

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.

string
required
length between 1 and 1000

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

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.

uri

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

string

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

IdentifierTypes
array of strings

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

IdentifierTypes
boolean

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

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

string
enum

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.

string
enum
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.

string

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.

string

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

string

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

string

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.

boolean
Defaults to false

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

boolean

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

boolean
Defaults to false

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.

boolean
Defaults to false

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.

boolean
Defaults to false

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.

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.

int32

The IAB Vendor Id. Used for legacy mobile Collection Points

DataElements
array of strings

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

DataElements
string

The Collection Point default language code

Languages
array of strings

List containing the Collection Point translations' language codes

Languages
boolean

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

boolean

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

boolean

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

uuid

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

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

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

boolean

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

boolean

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

boolean

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

boolean
Defaults to false

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

boolean
Defaults to true

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

boolean

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

boolean

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

attributeValues
object

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

HostedWebForm
object
PurposeIdsWithVersion
array of objects

A list containing the IDs of purposes along with their versions that this Collection Point is associated with. Each entry maps a purpose ID to a specific version.

PurposeIdsWithVersion
boolean
Defaults to false

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.

boolean
Defaults to false

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

boolean
Defaults to false

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

boolean
Defaults to false

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

string

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

string
enum

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

Allowed:
boolean
Defaults to false

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

boolean
Defaults to false

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

boolean
Defaults to false

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

boolean
Defaults to false

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

boolean
Defaults to false

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.

ParentIdentifierTypes
array of strings

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

ParentIdentifierTypes
string

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

string

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

string

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

boolean
Defaults to false

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

boolean
Defaults to false

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

boolean
Defaults to false

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

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Updated 4 months ago

Language
Credentials
OAuth2
Missing 1 required scope
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*
Updated 4 months ago