/onetrust-consent | Type: Application | PCID required: Yes
Tools
onetrust_consent_add_data_subjects_to_consent_group_using_post
Add Data Subjects to Parent Consent Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
consentGroupGuid | string | Yes | — | The UUID of the Consent Group. consentGroupGuid can be retrieved using the Get a paged view for consent groups API |
dataSubjects | any[] | No | — | A list of Data Subjects to be added to a Consent Group, identified either by their id or their identifier value |
onetrust_consent_add_purpose_rules_to_consent_group_using_post
Add Purpose Rules to Consent Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
consentGroupGuid | string | Yes | — | The UUID of the Consent Group. consentGroupGuid can be retrieved using the Get a paged view for consent groups API to add Purpose Rules |
purposeRules | any[] | No | — | A list of Purpose Rules to be added to a Consent Group |
onetrust_consent_create_collection_point_using_post
Create Collection Point Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
AckEmailIdentifier | string | No | — | The email address to use when sending acknowledgment emails. This can be different from the main contact email for the Collection Point. |
AllowMultipleIdentifierTypes | boolean | No | — | 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 |
attributeValues | object | No | — | A map of attribute names to their corresponding values and metadata. Used for storing custom attributes associated with the Collection Point. |
CollectionPointType | string | Yes | — | 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. |
consentDOICancelOption | boolean | No | — | 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. |
ConsentIntegration | boolean | No | — | 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 |
ConsentType | string | No | — | 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. |
CookieConsentUpdate | string | No | — | Specifies how cookie consent updates should be handled for this Collection Point. This determines the behavior when consent preferences change. |
DataControllerName | string | No | — | 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. |
DataElements | any[] | No | — | List of data element IDs that this Collection Point will collect consent for. Each data element represents a specific type of data processing activity. |
Description | string | Yes | — | Detailed description of the Collection Point. This should explain the purpose and functionality of the Collection Point. |
DisableReports | boolean | No | — | 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. |
DOIEmailIdentifier | string | No | — | The email address to use when sending double opt-in confirmation emails. If not specified, the primary email identifier will be used. |
DoiEmailToParent | boolean | No | — | 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. |
DOISendConfirmationEmail | boolean | No | — | 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 |
DoubleOptIn | boolean | No | — | Indicates whether double opt-in is required for this Collection Point. When enabled, users must confirm their consent via email. |
EnableCaptcha | boolean | No | — | When enabled, requires users to complete a CAPTCHA challenge before submitting the form. This helps prevent automated submissions and spam. |
enableCustomPreferenceEvent | boolean | No | — | When enabled, generates an event for custom preference changes made through this Collection Point. Useful for triggering workflows or integrations. |
enableDataElementEvent | boolean | No | — | When enabled, generates an event whenever a data element-related action occurs through this Collection Point. Useful for triggering workflows or integrations. |
EnableGeolocation | boolean | No | — | When enabled, captures the data subject’s geolocation (with their consent) for specific purposes. This feature is currently in preview. |
EnableGeoLocationForDataElements | boolean | No | — | When enabled, captures the data subject’s geolocation (with their consent) for specific data elements. This feature is currently in preview. |
EnableNewConsentIntegration | boolean | No | — | Setting to fire the Data Subject Profile Updated integrations event. For more information see this article |
EnablePrefillIdentifier | boolean | No | — | When enabled, allows the Collection Point to pre-fill identifier fields when possible, improving user experience for returning visitors. |
EnablePrimaryIdentifier | boolean | No | — | Setting to enable primary identifier functionality. When enabled, designates one of the identifiers as the primary identifier for the data subject. |
EnablePublishEvent | boolean | No | — | Setting to fire the Collection Point Published integrations event. For more information see this article |
enablePurposeEvent | boolean | No | — | When enabled, generates an event whenever a purpose-related action occurs through this Collection Point. Useful for triggering workflows or integrations. |
HostedSDK | boolean | No | — | Whether the SDK settings are published to external storage for quicker integration. This is enabled by default for all web form type collection points |
HostedWebForm | object | No | — | Hosted Web Form |
HowToWithdraw | string | No | — | Instructions on how a data subject can withdraw their consent. This should provide clear, actionable steps. |
IABVendorId | integer | No | — | The IAB Vendor Id. Used for legacy mobile Collection Points |
IdentifierDataElementId | string | No | — | 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 |
IdentifierTypes | any[] | No | — | Used in conjunction with the AllowMultipleIdentifierTypes setting. The List of Data Subject identifiers that can be used for the Collection Point |
includeIdentifierParameter | boolean | No | — | 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. |
includeParameter | boolean | No | — | 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. |
IsAuthenticationRequired | boolean | No | — | Setting to require authentication for a collection point. For more information see this article |
IsDynamicCollectionPoint | boolean | No | — | Whether this is a dynamic collection point or not. For more information see this article |
Language | string | No | — | The Collection Point default language code |
Languages | any[] | No | — | List containing the Collection Point translations’ language codes |
Name | string | Yes | — | 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. |
NewSdkIntegrationEnabled | boolean | No | — | 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 |
NoConsentTransactions | boolean | No | — | Whether no consent transactions can be recorded against the collection point. For more information about consent transaction types and purpose statuses see this article |
OrganizationId | string | Yes | — | 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. |
OtherInformation | string | No | — | 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. |
OverrideActivePurpose | boolean | No | — | 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 |
ParentIdentifierTypes | any[] | No | — | List of parent data subject identifier types for this Collection Point. Used with Consent on Behalf and Multiple Data Subject Identifiers features. |
PreferenceCenterGuid | string | No | — | Unique identifier for a Preference Center to associate with this Collection Point |
PrefillIdentifier | string | No | — | The identifier value to pre-fill in the form when known. This improves user experience by reducing data entry for returning visitors. |
PrimaryIdentifierType | string | No | — | The primary identifier type used to identify data subjects for this Collection Point. This is used when multiple identifier types are configured. |
PrivacyPolicyUrl | string | No | — | The URL of the privacy policy associated with this Collection Point. This is typically displayed to users when they are providing consent. |
PurposeId | string | No | — | 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 | any[] | No | — | 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. |
PurposeIdsWithVersion | any[] | No | — | 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. |
ReconfirmActivePurpose | boolean | No | — | 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 |
RedirectOnFormSubmission | boolean | No | — | When enabled, automatically redirects users to a specified URL after they submit the form. The redirect URL can be configured separately. |
RedirectUrl | string | No | — | The URL to redirect users to after they have completed the consent process. This is typically a thank you page or the main website. |
ResponsibleGroupId | string | No | — | The Unique Identifier of the Responsible Group. Note: this can be found in the url path when viewing Responsible Group details under global settings |
ResponsibleUserId | string | No | — | The Unique Identifier of the Responsible User. Note: this can be found in the url path when viewing Responsible User details under global settings |
RightToWithdraw | string | No | — | Information about the data subject’s right to withdraw consent. This is typically displayed to users to inform them of their rights. |
SendConsentEmail | boolean | No | — | Switch on or off the Consent Acknowledgement Email feature for a Collection Point |
SubjectIdentifier | string | No | — | 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 |
WebFormUrl | string | No | — | 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. |
onetrust_consent_create_consent_group_using_post
Create Consent Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | A description of the Consent Group |
externalName | string | No | — | The Consent Group’s external name. If not provided, this will be generated based on the name |
name | string | No | — | The Consent Group name |
onetrust_consent_create_custom_preference_using_post
Create Purpose Preference Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | Yes | — | Request body |
onetrust_consent_create_data_subject_group_v4
Create Data Subject Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupName | string | Yes | — | A user-defined name for the group of linked identities. |
memberIdentifiers | any[] | Yes | — | A list of all member identifiers that belong to the group. |
primaryIdentifiers | any[] | Yes | — | A List of all identifiers that are primary identifiers. The members in this list need not be present in member identifiers list as they are mutually exclusive. |
onetrust_consent_create_new_purpose_version_using_post
Create New Purpose Version Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
purposeGuid | string | Yes | — | Unique identifier of the Purpose. |
onetrust_consent_create_or_update_data_subject_using_post
Update Data Subject’s Data Elements Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataElements | any[] | No | — | List containing the Data Subject’s Data Elements |
identifierType | string | No | — | The type of identifier used for the Data Subject |
language | string | No | — | The preferred language code for the Data Subject |
onetrust_consent_create_purpose_using_post
Create Purpose Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
isInternalOrg | boolean | No | — | Specifies if the Purpose is for internal organization use |
attributeValues | object | No | — | Map of attribute values associated with the purpose |
ConsentLifeSpan | integer | Yes | — | The lifespan of consents recorded against this purpose in seconds |
CustomPreferenceIds | any[] | No | — | List of custom preference IDs associated with the purpose |
DefaultLanguage | string | No | — | The default language for the Purpose in BCP 47 format |
Description | string | Yes | — | Detailed description of the Purpose’s intended use |
EnableGeolocation | boolean | No | — | Flag to enable geolocation tracking for this purpose |
HardOptOutDisplayFormat | string | No | — | 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 | No | — | 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. |
ImplicitConsentConfirmDesc | string | No | — | Description shown when confirming implicit consent |
ImplicitConsentLifeSpan | integer | No | — | Lifespan for implicit consents in seconds |
IsMajorVersion | boolean | No | — | Indicates if this is a major version update |
LastMajorVersion | integer | No | — | Version number of the last major update |
Name | string | Yes | — | Name of the Purpose |
Organizations | any[] | No | — | A list of External Organization Ids. |
ParentPurposeId | string | No | — | Unique identifier of the parent purpose |
PurposeCategory | object | No | — | Purpose Category |
Type | string | No | — | Type of the Purpose |
VersionNotes | string | No | — | Release notes for the current version |
onetrust_consent_edit_collection_point_using_put
Update Existing Collection Point Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
collectionpointId | string | Yes | — | The unique identifier of the Collection Point to update. |
version | integer | No | — | The version of the Collection Point to update. If not provided, version 1 will be used. |
AckEmailIdentifier | string | No | — | The email address to use when sending acknowledgment emails. This can be different from the main contact email for the Collection Point. |
AllowMultipleIdentifierTypes | boolean | No | — | 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 |
attributeValues | object | No | — | 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. |
CollectionPointType | string | Yes | — | 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. |
consentDOICancelOption | boolean | No | — | 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. |
ConsentIntegration | boolean | No | — | 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 |
ConsentType | string | No | — | 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. |
CookieConsentUpdate | string | No | — | Specifies how cookie consent updates should be handled for this Collection Point. This determines the behavior when consent preferences change. |
DataControllerName | string | No | — | 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. |
DataElements | any[] | No | — | List of data element IDs that this Collection Point will collect consent for. Each data element represents a specific type of data processing activity. |
Description | string | Yes | — | Detailed description of the Collection Point. This should explain the purpose and functionality of the Collection Point. |
DisableReports | boolean | No | — | 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. |
DOIEmailIdentifier | string | No | — | The email address to use when sending double opt-in confirmation emails. If not specified, the primary email identifier will be used. |
DoiEmailToParent | boolean | No | — | 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. |
DOISendConfirmationEmail | boolean | No | — | 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 |
doNotActivateWebform | boolean | Yes | — | 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. |
DoubleOptIn | boolean | No | — | Indicates whether double opt-in is required for this Collection Point. When enabled, users must confirm their consent via email. |
doubleOptInExcludedPurposes | any[] | No | — | List of purposes that should be excluded from the Double Opt-In (DOI) requirement. When a purpose is in this list, users will not be required to confirm their consent via email for that specific purpose, even if DOI is enabled for the Collection Point. |
EnableCaptcha | boolean | No | — | When enabled, requires users to complete a CAPTCHA challenge before submitting the form. This helps prevent automated submissions and spam. |
enableCustomPreferenceEvent | boolean | No | — | When enabled, generates an event for custom preference changes made through this Collection Point. Useful for triggering workflows or integrations. |
enableDataElementEvent | boolean | No | — | When enabled, generates an event whenever a data element-related action occurs through this Collection Point. Useful for triggering workflows or integrations. |
EnableGeolocation | boolean | No | — | When enabled, captures the data subject’s geolocation (with their consent) for specific purposes. This feature is currently in preview. |
EnableGeoLocationForDataElements | boolean | No | — | When enabled, captures the data subject’s geolocation (with their consent) for specific data elements. This feature is currently in preview. |
EnableNewConsentIntegration | boolean | No | — | Setting to fire the Data Subject Profile Updated integrations event. For more information see this article |
EnablePrefillIdentifier | boolean | No | — | When enabled, allows the Collection Point to pre-fill identifier fields when possible, improving user experience for returning visitors. |
EnablePrimaryIdentifier | boolean | No | — | Setting to enable primary identifier functionality. When enabled, designates one of the identifiers as the primary identifier for the data subject. |
EnablePublishEvent | boolean | No | — | Setting to fire the Collection Point Published integrations event. For more information see this article |
enablePurposeEvent | boolean | No | — | When enabled, generates an event whenever a purpose-related action occurs through this Collection Point. Useful for triggering workflows or integrations. |
HostedSDK | boolean | No | — | Whether the SDK settings are published to external storage for quicker integration. This is enabled by default for all web form type collection points |
HostedWebForm | object | No | — | Hosted Web Form |
HostedWebformPublish | boolean | No | — | 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. |
HowToWithdraw | string | No | — | Instructions on how a data subject can withdraw their consent. This should provide clear, actionable steps. |
IABVendorId | integer | No | — | The IAB Vendor Id. Used for legacy mobile Collection Points |
IdentifierDataElementId | string | No | — | 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 |
IdentifierTypes | any[] | No | — | Used in conjunction with the AllowMultipleIdentifierTypes setting. The List of Data Subject identifiers that can be used for the Collection Point |
includeIdentifierParameter | boolean | No | — | 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. |
includeParameter | boolean | No | — | 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. |
IsAuthenticationRequired | boolean | No | — | Setting to require authentication for a collection point. For more information see this article |
IsDynamicCollectionPoint | boolean | No | — | Whether this is a dynamic collection point or not. For more information see this article |
Language | string | No | — | The Collection Point default language code |
Languages | any[] | No | — | List containing the Collection Point translations’ language codes |
LastSdkIntegrationDate | string | No | — | 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. |
Name | string | Yes | — | 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. |
NewSdkIntegrationEnabled | boolean | No | — | 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 |
NoConsentTransactions | boolean | No | — | Whether no consent transactions can be recorded against the collection point. For more information about consent transaction types and purpose statuses see this article |
Notices | any[] | No | — | The set of notices associated with this Collection Point. Notices define the privacy notices and consent requests that will be displayed to users. Each notice can be configured with different purposes, data categories, and consent requirements. |
OrganizationId | string | Yes | — | 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. |
OtherInformation | string | No | — | 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. |
OverrideActivePurpose | boolean | No | — | 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 |
ParentIdentifierTypes | any[] | No | — | List of parent data subject identifier types for this Collection Point. Used with Consent on Behalf and Multiple Data Subject Identifiers features. |
PortalSettings | object | No | — | 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. |
PreferenceCenterGuid | string | No | — | Unique identifier for a Preference Center to associate with this Collection Point |
PreferenceCenterSettings | object | No | — | 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. |
PrefillIdentifier | string | No | — | The identifier value to pre-fill in the form when known. This improves user experience by reducing data entry for returning visitors. |
PrimaryIdentifierType | string | No | — | The primary identifier type used to identify data subjects for this Collection Point. This is used when multiple identifier types are configured. |
PrivacyPolicyUrl | string | No | — | The URL of the privacy policy associated with this Collection Point. This is typically displayed to users when they are providing consent. |
PurposeId | string | No | — | 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 | any[] | No | — | 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. |
PurposeIdsWithVersion | any[] | No | — | 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. |
ReconfirmActivePurpose | boolean | No | — | 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 |
RedirectOnFormSubmission | boolean | No | — | When enabled, automatically redirects users to a specified URL after they submit the form. The redirect URL can be configured separately. |
RedirectUrl | string | No | — | The URL to redirect users to after they have completed the consent process. This is typically a thank you page or the main website. |
ResponsibleGroupId | string | No | — | The Unique Identifier of the Responsible Group. Note: this can be found in the url path when viewing Responsible Group details under global settings |
ResponsibleUserId | string | No | — | The Unique Identifier of the Responsible User. Note: this can be found in the url path when viewing Responsible User details under global settings |
RightToWithdraw | string | No | — | Information about the data subject’s right to withdraw consent. This is typically displayed to users to inform them of their rights. |
SendConsentEmail | boolean | No | — | Switch on or off the Consent Acknowledgement Email feature for a Collection Point |
Status | string | Yes | — | 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. |
SubjectIdentifier | string | No | — | 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 |
WebFormUrl | string | No | — | 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. |
onetrust_consent_edit_custom_preference_using_put
Update Purpose Preference Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customPreferenceId | string | Yes | — | The unique identifier of the Purpose Preference to update. |
CreatedDate | string | No | — | Timestamp when the Custom Preference was created |
DefaultLanguage | string | No | — | The default language code for this Custom Preference (BCP 47 format) |
Description | string | No | — | Detailed description explaining the purpose and usage of this Custom Preference |
Disabled | boolean | No | — | Indicates if this Custom Preference is currently disabled |
DisplayAs | string | Yes | — | Specifies how the preference options should be displayed in the UI |
Id | string | Yes | — | Unique identifier for the Custom Preference |
Languages | any[] | No | — | List of language configurations for this Custom Preference |
Name | string | Yes | — | The display name of the Custom Preference |
NumberOfLanguages | integer | No | — | Number of languages this Custom Preference has been translated into |
NumberOfOptions | integer | No | — | Total number of available options for this Custom Preference |
Options | any[] | No | — | List of available options for this Custom Preference |
Organizations | any[] | No | — | List of Organization IDs that have access to this Custom Preference |
Required | boolean | No | — | Indicates whether a response is mandatory for this Custom Preference |
SelectionType | string | Yes | — | Defines how options can be selected in this Custom Preference |
TotalLinkedActivePurposes | integer | No | — | Count of active purposes that reference this Custom Preference |
UpdatedDate | string | No | — | Timestamp when the Custom Preference was last updated |
onetrust_consent_edit_purpose_using_put
Update Purpose Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
purposeId | string | Yes | — | The unique identifier of the Purpose to be edited |
isInternalOrg | boolean | No | — | Specifies if the Purpose is for internal organization use |
attributeValues | object | No | — | Map of attribute values associated with the purpose |
ConsentLifeSpan | integer | Yes | — | The lifespan of consents recorded against this purpose in seconds |
CustomPreferenceIds | any[] | No | — | List of custom preference IDs associated with the purpose |
DefaultLanguage | string | No | — | The default language for the Purpose in BCP 47 format |
Description | string | Yes | — | Detailed description of the Purpose’s intended use |
EnableGeolocation | boolean | No | — | Flag to enable geolocation tracking for this purpose |
ExpiryDateType | string | No | — | Date field considered for Purpose lifespan/expiry |
HardOptOutDisplayFormat | string | No | — | 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 | No | — | 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. |
ImplicitConsentConfirmDesc | string | No | — | Description shown when confirming implicit consent |
ImplicitConsentLifeSpan | integer | No | — | Lifespan for implicit consents in seconds |
IsMajorVersion | boolean | No | — | Indicates if this is a major version update |
Languages | any[] | No | — | List of language-specific details for the Purpose |
LastMajorVersion | integer | No | — | Version number of the last major update |
Name | string | Yes | — | Name of the Purpose |
Organizations | any[] | No | — | A list of External Organization Ids. |
ParentPurposeId | string | No | — | Unique identifier of the parent purpose |
PurposeCategory | object | No | — | Purpose Category |
Status | string | Yes | — | The current status of the Purpose |
TopicIds | any[] | No | — | List of unique identifiers for Topics associated with this Purpose |
Type | string | No | — | Type of the Purpose |
Version | integer | Yes | — | Version number of the Purpose being updated |
VersionNotes | string | No | — | Release notes for the current version |
onetrust_consent_find_by_guid_using_get
Get Purpose Preference Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
custompreferenceId | string | Yes | — | The UUID of the Custom Preference to be retrieved |
includeTranslations | boolean | No | — | Parameter to include all of the Custom Preference’s translations (by default is set to false) |
onetrust_consent_find_receipt_using_get
Get Receipt Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The unique identifier of the receipt. |
includeNotgiven | boolean | No | — | If true, the response will include Non Given transactions. |
includeConsentStrings | boolean | No | — | If true, the response will include consent strings. |
onetrust_consent_get_all_profiles_by_data_subject_v4
Get List of All Purpose Details by Data Subject Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | The page number of the results. |
size | integer | No | — | The number of results per page. |
sort | string | No | — | The sort criteria that dictates the order of the results. |
onetrust_consent_get_collection_points_using_get
Get List of Collection Points Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataElementGuid | string | No | — | The unique identifier of the Data Element. |
organizationId | string | No | — | The unique identifier of an organization. This value can be obtained using the Retrieve Organization Structure API. |
page | integer | No | — | The page number of the results to retrieve (0-based index). |
size | integer | No | — | The number of records per page to return. |
sort | string | No | — | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
name | string | No | — | Filter collection points by name (case-insensitive contains match). |
purposeGuid | string | No | — | Filter collection points by the unique identifier of an associated purpose. |
collectionPointType | string | No | — | Filter collection points by type. |
consentType | string | No | — | Filter collection points by the type of consent they capture. |
status | string | No | — | Filter collection points by their current status. |
onetrust_consent_get_data_subject_basic_details_v4
Get Data Subject Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
isDNCInclude | boolean | No | — | Indicates whether to include data subject in the response if the data subject is in the DNC list. |
onetrust_consent_get_data_subject_details_v4
Get Data Subject Details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
includeConsentGroups | boolean | No | — | This flag indicates whether data subject group information is included in the response. |
includeAttachments | boolean | No | — | This flag indicates whether attachment information is included in the response. |
includeNotices | boolean | No | — | This flag indicates whether collection point notice information is included in the response. |
includeConsentStrings | boolean | No | — | This flag indicates whether consent string information is included in the response. |
isDNCInclude | boolean | No | — | Indicates whether to include data subject in the response if the data subject is in the DNC list. |
onetrust_consent_get_data_subject_groups_list_v4
Get List of Data Subject Groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | The page number of the results. |
size | integer | No | — | The number of results per page. |
sort | string | No | — | The sort criteria that dictates the order of the results. |
onetrust_consent_get_data_subject_profile_v4
Get Purpose Details by Data Subject Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
purposeGuid | string | Yes | — | The unique identifier of the purpose. |
onetrust_consent_get_data_subjects_for_purposes_using_get
Get List of Data Subjects by Purpose Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
purposeId | string | Yes | — | Unique identifier of the Purpose for which to retrieve data subjects |
lastTransactionDate | string | No | — | Filter data subjects by last transaction date (ISO 8601 format: yyyy-MM-dd’T’HH:mm:ss) |
transactionStatus | string | No | — | Filter data subjects by transaction status |
includeCustomPreferences | boolean | No | — | Include custom preference options in the response |
onetrust_consent_get_data_subjects_v4
Get List of Data Subjects Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fromDate | string | Yes | — | The start of a date and time range used to filter results. |
toDate | string | Yes | — | The end of a date and time range used to filter results. |
isDNCInclude | boolean | No | — | Indicates whether to include data subject in the response if the data subject is in the DNC list. |
page | integer | No | — | The page number of the results. |
size | integer | No | — | The number of results per page. |
sort | string | No | — | The sort criteria that dictates the order of the results. |
onetrust_consent_get_group_list_using_get
Get List of Consent Groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | No | — | Name of the Consent Group |
onetrust_consent_get_group_using_get
Get Consent Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
consentGroupGuid | string | Yes | — | The UUID of the Consent Group. consentGroupGuid can be retrieved using the Get a paged view for consent groups API |
onetrust_consent_get_grouped_purposes_v2
Get List of Purpose Versions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
latestVersion | boolean | No | — | In order to retrieve only the latest version of each Purpose this property should be set to true. |
includeRetired | boolean | No | — | In order to include retired versions for each Purpose this property should be set to true. |
organization | string | No | — | Organization ID to filter purposes by. |
includeCustomPreferences | boolean | No | — | In order to retrieve custom preferences for each version of Purposes this property should be set to true. |
includeTopics | boolean | No | — | In order to retrieve topics for each version of Purposes this property should be set to true. |
fromLastModifiedDate | string | No | — | Filter purposes modified after this date (format: yyyy-MM-dd’T’HH:mm:ss). |
toLastModifiedDate | string | No | — | Filter purposes modified before this date (format: yyyy-MM-dd’T’HH:mm:ss). |
page | integer | No | — | Results page you want to retrieve (0-based). |
size | integer | No | — | Number of records per page. |
sort | string | No | — | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
onetrust_consent_get_linked_identity_group_members_v4
Get List of Data Subject Group Members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataSubjectGroupId | string | Yes | — | The unique identifier for a Data Subject Group. |
page | integer | No | — | The page number of the results. |
size | integer | No | — | The number of results per page. |
sort | string | No | — | The sort criteria that dictates the order of the results. |
onetrust_consent_get_list_using_get
Get List of Purpose Preferences Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | The page number of the results (0-based). |
size | integer | No | — | The number of results per page. |
sort | string | No | — | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
onetrust_consent_get_preference_center_by_id_using_get
Get Preference Center Schema Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
prefcenterId | string | Yes | — | Preference Center UUID |
state | string | No | — | Draft or published preference center |
onetrust_consent_get_preference_center_page_schema_using_get
Get Preference Center Page Schema Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
preferencecenterpageid | string | Yes | — | Unique identifier of the Preference Center Page. |
state | string | No | — | The state of the Preference Center. |
onetrust_consent_get_preference_centers_using_get
Get List of Preference Centers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Results page you want to retrieve (0-based). |
size | integer | No | — | Number of records per page. |
sort | string | No | — | Sorting criteria in the format: property,(asc|desc). Default sort order is descending by ID. Multiple sort criteria are supported. |
dataElementGuid | string | No | — | Filter preference centers by data element GUID. |
onetrust_consent_get_purpose_detail_using_get
Get Purpose Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
purposeId | string | Yes | — | Unique identifier of the Purpose |
status | string | No | — | The status of the Purpose to be retrieved (ACTIVE or DRAFT). By default, ACTIVE is returned. |
version | integer | No | — | Version number of the Purpose to be retrieved |
onetrust_consent_get_receipt_list_details_using_post
Get List of Receipts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
collectionPointGuid | string | No | — | UUID of the Collection Point. |
receiptId | string | No | — | UUID of the receipt. |
purposeGuid | string | No | — | UUID of the Purpose. purposeGuid can be obtained using the Get A Paged List Of Purposes endpoint. |
organizationId | string | No | — | UUID of the Organization. organizationId can be obtained using the Retrieve Organization Structure endpoint. |
fromDate | string | No | — | Date from which to return records. Formats accepted are yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss. |
toDate | string | No | — | To date to return records. Formats accepted are yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss. |
includeDataElements | boolean | No | — | When set to true will include data subject data elements on the receipt payload. |
includeArchived | boolean | No | — | This parameter will fetch up to 1000 historical receipts per API call that are not yet stored in the Azure Cosmos DB or those that have reached their time-to-live (TTL) expiration of 90 days. |
isAnonymous | boolean | No | — | The isAnonymous parameter will be ignored. Anonymous receipts can only be returned by using the identifier or receiptId parameter. |
includeConsentStrings | boolean | No | — | This parameter will return consent strings stored in receipts. Note that it must be used in conjunction with an identifier or receiptId filter. |
page | integer | No | — | Results page to be retrieved (0..N). |
size | integer | No | — | Number of records per page (1..50). |
sort | string | No | — | Sorting criteria in the format: property,direction (where direction is asc or desc). Supported properties: consentCreationDate, interactionDate, id. |
nextMarker | string | No | — | Request continuation token used to paginate over historical receipts |
requestContinuation | string | No | — | Request continuation token used to paginate. If the number of records in the response is more than a page, it returns a requestContinuation token in the response. This requestContinuation token should be passed to the next request’s body to paginate. |
onetrust_consent_get_receipt_list_using_get
Get List of Receipts by Data Subjectonetrust_consent_get_root_schema_using_get
Get Preference Center Root Schema Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
preferencecenterid | string | Yes | — | Unique identifier of the Preference Center. |
state | string | No | — | The state of the Preference Center. |
onetrust_consent_get_token_using_get
Get Collection Point Token Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
collectionpointGuid | string | Yes | — | The unique identifier of the Collection Point |
version | integer | No | — | The specific version of the Collection Point to get the token for. If not provided, the most recent version will be used. |
state | string | No | — | Filter by the state of the Collection Point |
onetrust_consent_get_transactions_using_post
Get List of Transactions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fromDate | string | No | — | Retrieve transactions recorded after the specified date. Formats accepted: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS |
toDate | string | No | — | Retrieve transactions recorded up to the specified date. Formats accepted: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS |
collectionPointGuid | string | No | — | UUID of the Collection Point |
page | integer | No | — | Results page to be retrieved (0..N). |
size | integer | No | — | Number of records per page (1..50). |
sort | string | No | — | Sorting criteria in the format: property,direction (where direction is asc or desc). Supported properties: consentCreationDate. |
nextMarker | string | No | — | Request continuation token used to paginate over historical receipts |
requestContinuation | string | No | — | Request continuation token used to paginate. If the number of records in the response is more than a page, it returns a requestContinuation token in the response. This requestContinuation token should be passed to the next request’s body to paginate. |
onetrust_consent_publish_purpose_using_put
Publish Purpose Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
purposeId | string | Yes | — | Unique identifier of the Purpose. |
version | integer | Yes | — | The Purpose’s version. |
onetrust_consent_search_data_subjects_post_using_post
Search Data Subjects Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number (0-based). |
size | integer | No | — | Number of records per page (1-2000). |
isDNCInclude | boolean | No | — | Include Do Not Call list information (true/false). |
dataElements | any[] | No | — | Filter Data Subject records by data elements with specific names and values |
id | string | No | — | Filter Data Subject records by GUID |
identifier | string | No | — | Filter Data Subject records by identifier (e.g., email, phone number) |
ignoreDefaultSort | boolean | No | — | When true, overrides the default sorting by last modified date |
includeCounts | boolean | No | — | When false, the response will not include the total record count (improves performance for large result sets) |
includeDataSubjectsWithOutPurposeTransactions | boolean | No | — | When true, includes Data Subjects that don’t have any purpose transactions |
language | string | No | — | Filter Data Subject records by preferred language code |
linkedDS | boolean | No | — | When true, includes additional linked Data Subject information in the response |
linkTokens | boolean | No | — | When true, includes link tokens in the response for magic link functionality |
orgIds | any[] | No | — | Filter Data Subject records by organization IDs (internal use only) |
updatedSince | string | No | — | Filter Data Subject records updated on or after this date (format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss) |
updatedUntil | string | No | — | Filter Data Subject records updated on or before this date (format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss) |
onetrust_consent_set_retirement_using_put
Retire Purpose Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
purposeId | string | Yes | — | Unique identifier of the Purpose. |
date | string | No | — | Date when a Purpose will expire (YYYY-MM-DD). |
onetrust_consent_update_data_subject_group_v4
Update Data Subject Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataSubjectGroupId | string | Yes | — | The unique identifier for the Data Subject Group to be updated. |
groupName | string | Yes | — | A user-defined name for the group of linked identities. |
memberIdentifiers | any[] | Yes | — | A list of all member identifiers that belong to the group. |
primaryIdentifiers | any[] | Yes | — | A List of all identifiers that are primary identifiers. The members in this list need not be present in member identifiers list as they are mutually exclusive. |
onetrust_consent_update_preferences_for_data_subject_api_using_put
Update Data Subject’s Preferences in a Preference Center Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
prefcenterId | string | Yes | — | Preference Center UUID. |
identifier | string | No | — | Data Subject Identifier (prefer the header parameter). |
dsDataElements | object | No | — | Ds Data Elements |
DsDataElements | object | No | — | Map of Data Subject Elements and their values. Maximum supported characters for a data element value is 750. |
Language | string | No | — | The preferred language of the Data Subject in BCP 47 format |
Purposes | any[] | Yes | — | List of Data Subject Purposes with their consent status |