> ## Documentation Index > Fetch the complete documentation index at: https://developer.onetrust.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Consent & Preferences - Universal Consent & Preference Management (OAS)", "version": "1.0", "contact": { "name": "OneTrust Support", "url": "https://my.onetrust.com/s/contactsupport" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "description": "The Universal Consent & Preference Management APIs are used to integrate external systems and streamline the flow of data with Universal Consent & Preference Management in the OneTrust Platform." }, "servers": [ { "url": "https://{hostname}", "variables": { "hostname": { "default": "hostname", "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com." } } } ], "tags": [ { "name": "Collection Points", "description": "The Collection Points APIs are used to manage where and how consent is collected.", "externalDocs": { "description": "OpenAPI 3.1.0 - Download Definition", "url": "https://developer.onetrust.com/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json" }, "x-displayName": "Collection Points" } ], "paths": { "/api/consentmanager/v1/collectionpoints/{collectionpointId}": { "put": { "operationId": "editCollectionPointUsingPUT", "summary": "Update Existing Collection Point", "description": "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.\n\n> 🗒 Things to Know\n> \n> - One of the following parameters must be included in the API request body: `PurposeId`, `PurposeIds`, or `PurposeIdsWithVersion`.\n> - The `PurposeId` and `PurposeIds` parameters can be used to link an **Active** version of a purpose to a Collection Point.\n> - The `PurposeIdsWithVersion` parameter can be used to link specific versions of a purpose (either in **Draft** or **Active** status) to a Collection Point.", "tags": [ "Collection Points" ], "x-onetrust": { "spec-label": "https://developer.onetrust.com/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json" }, "parameters": [ { "name": "collectionpointId", "in": "path", "description": "The unique identifier of the Collection Point to update.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000", "maxLength": 36, "minLength": 36 } }, { "name": "version", "in": "query", "description": "The version of the Collection Point to update. If not provided, version 1 will be used.", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1, "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointEditRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).", "headers": { "Retry-After": { "schema": { "description": "The number of seconds after which requests will be allowed again.", "format": "int32" } }, "ot-period": { "schema": { "description": "The unit of time for which the rate limit applies", "enum": [ "HOUR", "MINUTE" ] } }, "ot-ratelimit-event-id": { "schema": { "description": "The unique identifier for the rate-limiting event.", "format": "uuid" } }, "ot-request-made": { "schema": { "description": "The number of requests made within the specified period.", "format": "int32" } }, "ot-requests-allowed": { "schema": { "description": "The number of requests allowed within the specified period.", "format": "int32" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2": [ "CONSENT" ] } ] } } }, "components": { "schemas": { "ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointEditRequest": { "type": "object", "properties": { "OrganizationId": { "description": "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.", "type": "string", "format": "uuid", "example": "92cf3a3a-09a9-4d04-b69d-ea5bb1db550a" }, "PurposeId": { "description": "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.", "type": "string", "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46,a6d68a29-a185-40e8-ac4c-5656d4856b0a" }, "PurposeIds": { "description": "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.", "type": "array", "items": { "type": "string", "format": "uuid", "description": "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." }, "example": [ "f2229953-b4b5-4042-8cb9-b78038cc4c46", "a6d68a29-a185-40e8-ac4c-5656d4856b0a" ] }, "Name": { "description": "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.", "type": "string", "example": "Website Consent Banner", "maxLength": 255, "minLength": 1 }, "Description": { "description": "Detailed description of the Collection Point. This should explain the purpose and functionality of the Collection Point.", "type": "string", "example": "This collection point is used to collect consent for marketing cookies on the main website.", "maxLength": 1000, "minLength": 1 }, "WebFormUrl": { "description": "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.", "type": "string", "format": "uri", "example": "https://example.com/consent-form", "pattern": "https?://.*" }, "PrivacyPolicyUrl": { "description": "The URL of the privacy policy associated with this Collection Point. This is typically displayed to users when they are providing consent.", "type": "string", "format": "uri", "example": "https://example.com/privacy-policy" }, "SubjectIdentifier": { "description": "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", "type": "string", "example": "Email" }, "IdentifierTypes": { "description": "Used in conjunction with the `AllowMultipleIdentifierTypes` setting. The List of Data Subject identifiers that can be used for the Collection Point", "type": "array", "items": { "type": "string" } }, "AllowMultipleIdentifierTypes": { "description": "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", "type": "boolean", "example": false }, "IdentifierDataElementId": { "description": "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", "type": "string", "format": "uuid", "example": "7912bfe1-37dd-4180-8b99-963e80f3e125" }, "ConsentType": { "description": "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.", "type": "string", "example": "EXPLICIT", "enum": [ "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" ] }, "CollectionPointType": { "description": "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.", "type": "string", "example": "WEB_FORM", "enum": [ "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" ] }, "DataControllerName": { "description": "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.", "type": "string", "example": "Acme Corp" }, "RightToWithdraw": { "description": "Information about the data subject's right to withdraw consent. This is typically displayed to users to inform them of their rights.", "type": "string", "example": "You have the right to withdraw your consent at any time." }, "HowToWithdraw": { "description": "Instructions on how a data subject can withdraw their consent. This should provide clear, actionable steps.", "type": "string", "example": "To withdraw your consent, please contact our Data Protection Officer at dpo@example.com." }, "OtherInformation": { "description": "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.", "type": "string", "example": "Processing is necessary for the performance of a contract to which the data subject is party." }, "DoubleOptIn": { "description": "Indicates whether double opt-in is required for this Collection Point. When enabled, users must confirm their consent via email.", "type": "boolean", "example": false, "default": false }, "DOISendConfirmationEmail": { "description": "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", "type": "boolean", "example": false }, "DoiEmailToParent": { "description": "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.", "type": "boolean", "example": false, "default": false }, "consentDOICancelOption": { "description": "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.", "type": "boolean", "example": false, "default": false }, "includeParameter": { "description": "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.", "type": "boolean", "example": false, "default": false }, "RedirectUrl": { "description": "The URL to redirect users to after they have completed the consent process. This is typically a thank you page or the main website.", "type": "string", "format": "uri", "example": "https://example.com/thank-you" }, "IABVendorId": { "description": "The IAB Vendor Id. Used for legacy mobile Collection Points", "type": "integer", "format": "int32", "example": 13 }, "DataElements": { "description": "List of data element IDs that this Collection Point will collect consent for. Each data element represents a specific type of data processing activity.", "type": "array", "items": { "type": "string", "description": "The unique identifier of a data element", "example": "marketing" }, "example": [ "marketing", "analytics", "preferences" ] }, "Language": { "description": "The Collection Point default language code", "type": "string", "example": "en-us" }, "Languages": { "description": "List containing the Collection Point translations' language codes", "type": "array", "items": { "type": "string" } }, "NoConsentTransactions": { "description": "Whether no consent transactions can be recorded against the collection point. For more information about consent transaction types and purpose statuses see this [article](https://my.onetrust.com/s/article/UUID-d4ed05a9-a999-f2cb-8272-610a5817b43f?topicId=0TO1Q000000bHgoWAE)", "type": "boolean", "example": false }, "HostedSDK": { "description": "Whether the SDK settings are published to external storage for quicker integration. This is enabled by default for all web form type collection points", "type": "boolean", "example": false }, "SendConsentEmail": { "description": "Switch on or off the Consent Acknowledgement Email feature for a Collection Point", "type": "boolean", "example": false }, "PreferenceCenterGuid": { "description": "Unique identifier for a Preference Center to associate with this Collection Point", "type": "string", "format": "uuid", "example": "09ccd1b9-84a0-4bcb-a167-f761391ebffa" }, "ResponsibleUserId": { "description": "The Unique Identifier of the Responsible User. Note: this can be found in the url path when viewing Responsible User details under global settings", "type": "string", "format": "uuid", "example": "bc4836e2-c117-461b-a7a2-2b268c037a97" }, "ResponsibleGroupId": { "description": "The Unique Identifier of the Responsible Group. Note: this can be found in the url path when viewing Responsible Group details under global settings", "type": "string", "format": "uuid", "example": "5466af43-ff42-4a39-8722-5a98e7981fc4" }, "ConsentIntegration": { "description": "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", "type": "boolean", "example": false }, "EnableNewConsentIntegration": { "description": "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](https://my.onetrust.com/s/article/UUID-58e8b9fb-0e47-5aca-713b-c2f26102d60c)", "type": "boolean", "example": false }, "IsAuthenticationRequired": { "description": "Setting to require authentication for a collection point. For more information see this [article](https://my.onetrust.com/s/article/UUID-b359a104-1900-9ac9-7765-ee08c8047f1d?topicId=0TO3q000000kIUHGA2)", "type": "boolean", "example": false }, "ReconfirmActivePurpose": { "description": "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", "type": "boolean", "example": false, "default": false }, "OverrideActivePurpose": { "description": "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", "type": "boolean", "example": true, "default": true }, "IsDynamicCollectionPoint": { "description": "Whether this is a dynamic collection point or not. For more information see this [article](https://my.onetrust.com/s/article/UUID-358c7e03-1d60-ff3b-e443-25d4283c7ac3?topicId=0TO3q000000kIWXGA2)", "type": "boolean", "example": false }, "NewSdkIntegrationEnabled": { "description": "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", "type": "boolean", "example": false }, "attributeValues": { "description": "A map of attribute values associated with this Collection Point.\n\nThis 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.", "type": "object", "additionalProperties": true }, "HostedWebForm": { "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_HostedWebFormDto" }, "PurposeIdsWithVersion": { "description": "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.", "type": "array", "items": { "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_IdVersionPairDto" }, "example": [ { "id": "7912bfe1-37dd-4180-8b99-963e80f3e125", "version": 1 } ] }, "includeIdentifierParameter": { "description": "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.", "type": "boolean", "example": false, "default": false }, "EnablePublishEvent": { "description": "Setting to fire the Collection Point Published integrations event. For more information see this [article](https://my.onetrust.com/s/article/UUID-58e8b9fb-0e47-5aca-713b-c2f26102d60c)", "type": "boolean", "example": false, "default": false }, "EnablePrimaryIdentifier": { "description": "Setting to enable primary identifier functionality. When enabled, designates one of the identifiers as the primary identifier for the data subject.", "type": "boolean", "example": false, "default": false }, "EnableCaptcha": { "description": "When enabled, requires users to complete a CAPTCHA challenge before submitting the form. This helps prevent automated submissions and spam.", "type": "boolean", "example": false, "default": false }, "PrimaryIdentifierType": { "description": "The primary identifier type used to identify data subjects for this Collection Point. This is used when multiple identifier types are configured.", "type": "string", "example": "Email" }, "CookieConsentUpdate": { "description": "Specifies how cookie consent updates should be handled for this Collection Point. This determines the behavior when consent preferences change.", "type": "string", "example": "UPDATE_ALL", "enum": [ "UPDATE_ALL", "SKIP_TRANSACTION" ] }, "EnableGeolocation": { "description": "When enabled, captures the data subject's geolocation (with their consent) for specific purposes. This feature is currently in preview.", "type": "boolean", "example": false, "default": false }, "EnablePrefillIdentifier": { "description": "When enabled, allows the Collection Point to pre-fill identifier fields when possible, improving user experience for returning visitors.", "type": "boolean", "example": false, "default": false }, "EnableGeoLocationForDataElements": { "description": "When enabled, captures the data subject's geolocation (with their consent) for specific data elements. This feature is currently in preview.", "type": "boolean", "example": false, "default": false }, "RedirectOnFormSubmission": { "description": "When enabled, automatically redirects users to a specified URL after they submit the form. The redirect URL can be configured separately.", "type": "boolean", "example": false, "default": false }, "DisableReports": { "description": "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.", "type": "boolean", "example": false, "default": false }, "ParentIdentifierTypes": { "description": "List of parent data subject identifier types for this Collection Point. Used with Consent on Behalf and Multiple Data Subject Identifiers features.", "type": "array", "items": { "type": "string" }, "example": [ "Email", "Mobile" ] }, "DOIEmailIdentifier": { "description": "The email address to use when sending double opt-in confirmation emails. If not specified, the primary email identifier will be used.", "type": "string", "example": "user@example.com" }, "AckEmailIdentifier": { "description": "The email address to use when sending acknowledgment emails. This can be different from the main contact email for the Collection Point.", "type": "string", "example": "acknowledgment@example.com" }, "PrefillIdentifier": { "description": "The identifier value to pre-fill in the form when known. This improves user experience by reducing data entry for returning visitors.", "type": "string", "example": "user@example.com" }, "enablePurposeEvent": { "description": "When enabled, generates an event whenever a purpose-related action occurs through this Collection Point. Useful for triggering workflows or integrations.", "type": "boolean", "example": false, "default": false }, "enableDataElementEvent": { "description": "When enabled, generates an event whenever a data element-related action occurs through this Collection Point. Useful for triggering workflows or integrations.", "type": "boolean", "example": false, "default": false }, "enableCustomPreferenceEvent": { "description": "When enabled, generates an event for custom preference changes made through this Collection Point. Useful for triggering workflows or integrations.", "type": "boolean", "example": false, "default": false }, "Status": { "description": "The current status of the Collection Point.\n\nThis field determines whether the Collection Point is active, inactive, or in another state. Only active Collection Points will be served to end users.", "type": "string", "example": "ACTIVE", "enum": [ "DRAFT", "ACTIVE", "RETIRED", "INACTIVE", "ACTIVE", "INACTIVE", "DRAFT", "ARCHIVED" ] }, "PreferenceCenterSettings": { "description": "A key-value map containing all Preference Center settings for this Collection Point.\n\nThese 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.", "type": "object", "example": { "theme": { "primaryColor": "#007bff" }, "features": { "saveButton": true } }, "additionalProperties": true }, "PortalSettings": { "description": "A key-value map containing all Portal settings for this Collection Point.\n\nThese 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.", "type": "object", "example": { "showBanner": true, "consentPurposes": [ "analytics", "marketing" ] }, "additionalProperties": true }, "LastSdkIntegrationDate": { "description": "The timestamp when the SDK integration was last synchronized with this Collection Point.\n\nThis 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.", "type": "string", "format": "date-time", "example": "2023-01-15T10:30:00Z", "readOnly": true }, "Notices": { "description": "The set of notices associated with this Collection Point.\n\nNotices 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.", "type": "array", "items": { "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointNoticeCreateDto" } }, "HostedWebformPublish": { "description": "Flag indicating whether to publish the hosted webform for this Collection Point.\n\nWhen 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.\n\nNote: This field is only applicable for Collection Points with `collectionPointType` set to `HOSTED_WEB_FORM`.", "type": "boolean", "example": true, "default": false }, "doubleOptInExcludedPurposes": { "description": "List of purposes that should be excluded from the Double Opt-In (DOI) requirement.\n\nWhen 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.", "type": "array", "items": { "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DoubleOptInExcludedPurposes" } }, "doNotActivateWebform": { "description": "When set to `true`, prevents the embedded webform from being automatically activated.\n\nThis 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.", "type": "boolean", "example": false, "default": false } }, "required": [ "CollectionPointType", "Description", "Name", "OrganizationId", "Status", "doNotActivateWebform" ] }, "ConsentPreferences-UniversalConsentPreferenceManag_CollectionPointNoticeCreateDto": { "properties": { "name": { "description": "Name of the collection point notice", "type": "string", "example": "Marketing Preferences Notice", "minLength": 1 }, "url": { "description": "URL associated with the notice", "type": "string", "example": "https://example.com/privacy-notice" }, "privacyNoticeGuid": { "description": "Unique identifier of the privacy notice", "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "type": { "description": "Type of the collection point notice", "type": "string", "example": "PRIVACY_NOTICE", "enum": [ "LINKED", "EMBEDDED" ] }, "purposeId": { "description": "Deprecated: Use purposeIds instead. Single purpose ID associated with the notice", "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000", "deprecated": true }, "purposeIds": { "description": "Set of purpose IDs associated with the notice", "type": "array", "items": { "type": "string", "format": "uuid", "description": "Set of purpose IDs associated with the notice" }, "example": [ "123e4567-e89b-12d3-a456-426614174000", "223e4567-e89b-12d3-a456-426614174001" ], "uniqueItems": true }, "noticeType": { "description": "Type of notice being created", "type": "string", "example": "PRIVACY_NOTICE", "enum": [ "PRIVACY_NOTICE", "DIGITAL_POLICY" ] } }, "required": [ "noticeType", "type" ] }, "ConsentPreferences-UniversalConsentPreferenceManag_DoubleOptInExcludedPurposes": { "properties": { "purposeGuid": { "description": "Unique identifier of the purpose", "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "excludeFromDoubleOptIn": { "description": "Flag indicating whether the purpose should be excluded from double opt-in requirements", "type": "boolean", "example": true } }, "required": [ "excludeFromDoubleOptIn", "purposeGuid" ] }, "ConsentPreferences-UniversalConsentPreferenceManag_HostedWebFormDto": { "properties": { "Id": { "description": "Unique identifier for the hosted web form", "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "Name": { "description": "Name of the hosted web form", "type": "string", "example": "Main Consent Form", "maxLength": 255, "minLength": 1 }, "WebFormData": { "description": "JSON configuration data for the web form", "type": "object" }, "BrandingData": { "description": "Branding configuration for the web form", "type": "object" }, "SdkVersion": { "description": "Version of the SDK used for the web form", "type": "string", "example": "1.0.0" }, "PublishedLink": { "description": "URL to access the published version of the web form", "type": "string", "format": "uri", "example": "https://example.com/consent-form/published" }, "DraftLink": { "description": "URL to access the draft version of the web form", "type": "string", "format": "uri", "example": "https://example.com/consent-form/draft" }, "VersionId": { "description": "Unique identifier for the current version of the hosted web form", "type": "string", "format": "uuid", "example": "b6e376c3-e838-439f-a01b-1af24cf9a5ac" }, "DefaultLanguageTranslations": { "description": "Default language translations for the web form", "type": "object", "example": { "en": "English", "es": "Spanish" }, "additionalProperties": { "type": "string", "description": "Default language translations for the web form", "example": "{\"en\":\"English\",\"es\":\"Spanish\"}" } }, "PortalData": { "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_HostedWebFormPortalData" }, "TestScriptGuid": { "description": "Unique identifier for the test embedded script", "type": "string", "format": "uuid", "example": "65840dad-c063-48d1-82e0-b9ec79f27908" }, "ProdScriptGuid": { "description": "Unique identifier for the production embedded script", "type": "string", "format": "uuid", "example": "2defe229-42b9-4a16-85be-7e9610240d31" }, "previewId": { "description": "Unique identifier for the web form draft version", "type": "string", "format": "uuid", "example": "f7cd1221-04a1-4523-89bf-3430c91b5cc9" }, "TestPublishVersion": { "description": "Version number of the last test publish", "type": "string", "example": "1.0.0" }, "ProdPublishVersion": { "description": "Version number of the last production publish", "type": "string", "example": "1.0.1" }, "supportedScriptVersion": { "description": "List of supported script versions for the web form.", "type": "array", "items": { "type": "string" }, "example": [ "1.0.0", "2.0.0" ] }, "NewSelectedLanguages": { "description": "List of newly selected languages for the web form", "type": "array", "items": { "type": "string" }, "example": [ "en", "es", "fr" ] }, "IntegrationUrls": { "description": "A list of External Organization Ids.", "type": "array", "items": { "type": "string" }, "example": [ "https://example.com/integration1", "https://example.com/integration2" ] }, "IntegrationSettings": { "description": "Configuration settings for various integrations", "type": "object", "example": { "analytics": { "enabled": true }, "crm": { "enabled": false } }, "additionalProperties": { "type": "object", "description": "Configuration settings for various integrations", "example": { "analytics": { "enabled": true }, "crm": { "enabled": false } } } }, "formTemplate": { "description": "Template identifier for web form customization", "type": "string", "example": "default-template" } }, "required": [ "Name", "SdkVersion", "WebFormData" ] }, "ConsentPreferences-UniversalConsentPreferenceManag_HostedWebFormPortalData": { "properties": { "DefaultLanguage": { "description": "Default language code for the web form portal", "type": "string", "example": "en" }, "SelectedLanguage": { "description": "Set of language codes that are selected/available in the web form portal", "type": "array", "items": { "type": "string" }, "example": [ "en", "es", "fr" ], "uniqueItems": true }, "CustomTranslations": { "description": "Custom translations for the web form portal. Nested map structure where the first key is the language code and the inner map contains key-value pairs of translation keys and their values.", "type": "object", "example": { "es": { "welcome.message": "Bienvenido" }, "fr": { "welcome.message": "Bienvenue" } }, "additionalProperties": { "type": "object", "additionalProperties": { "type": "string", "description": "Custom translations for the web form portal. Nested map structure where the first key is the language code and the inner map contains key-value pairs of translation keys and their values.", "example": "{\"es\":{\"welcome.message\":\"Bienvenido\"},\"fr\":{\"welcome.message\":\"Bienvenue\"}}" }, "description": "Custom translations for the web form portal. Nested map structure where the first key is the language code and the inner map contains key-value pairs of translation keys and their values.", "example": { "es": { "welcome.message": "Bienvenido" }, "fr": { "welcome.message": "Bienvenue" } } } } }, "required": [ "CustomTranslations", "DefaultLanguage" ] }, "ConsentPreferences-UniversalConsentPreferenceManag_IdVersionPairDto": { "properties": { "Id": { "description": "The unique identifier of the entity", "type": "string", "format": "uuid", "example": "fcfe3c5e-6b1d-4eac-a5a4-aa7c8719b279" }, "Version": { "description": "The version of the entity", "type": "integer", "format": "int64", "example": 1 } }, "example": [ { "id": "7912bfe1-37dd-4180-8b99-963e80f3e125", "version": 1 } ], "required": [ "Id" ] } }, "securitySchemes": { "ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://{hostname}/api/access/v1/oauth/token", "scopes": { "CONSENT": "Consent Scope gives the user access to read/write operations", "CONSENT_READ": "Consent Read Scope gives the user read-only access" } } } } } }, "x-readme": { "explorer-enabled": false, "proxy-enabled": false, "metrics-enabled": false }, "x-onetrust": { "spec-label": "OpenAPI 3.1.0" } } ```