Configuring Custom API Collection Point Settings
You can configure settings for your Custom API type collection point on the Settings tab on the Collection Point Details screen. Various settings are available, including configuration options for double opt-In, collection point events, and data subject authentication.
To configure settings for Custom API Collection Points
Settings Tab Reference
Confirmation section
- Field
- Description
- Double opt in
-
Enable this setting to utilize a two-step opt-in process to confirm a data subject's consent. For more information on configuring double opt-in, see Configuring Double Opt-In for a Collection Point.
- Double opt in: Redirect URL
-
Enter the URL where the data subject should be redirected after confirming or canceling consent by clicking the received link in the double opt in confirmation email message.
- Double opt in: Include Redirect URL Parameters
-
Enable this setting to include language and consent parameters within the Redirect URL in order to redirect data subjects to a page that reflects their selected language and consent preference.
Note:This setting appears only after a valid URL has been entered into the Redirect URL field.
- Double opt in: Include Identifier Parameter
-
Enable this setting to include an identifier parameter within the Redirect URL, which allows for data subjects to be redirected to a landing page without requiring them to re-enter their identifier details.
Note:This setting appears only after a valid URL has been entered into the Redirect URL field and the Include Redirect URL Parameters setting has been enabled.
- Double opt in: Cancel confirmation option
-
Enable this setting to include an option for data subjects to cancel the Pending status for the purpose(s) within the double opt in confirmation email message. The status of the purpose(s) will then be updated to Not Given.
- Double opt in: Request confirmation every time
-
Enable this setting to trigger a confirmation email for existing data subjects that submit consent for already Active purposes.
- Double opt in: Override Active Purpose With Pending
-
This setting is enabled by default if the Request confirmation every time setting has been enabled. Disable this setting to ensure that a purpose remains in the Active status instead of switching to Pending if a data subject resubmits consent.
- Double opt in: Send confirmation email
-
This setting is enabled by default if Email is selected as the data subject identifier for the collection point and unavailable if a non-email data subject identifier is selected. You can disable this setting to stop the sending of automated double opt in confirmation emails and trigger an integration event instead.
- Double opt in: Communication Method for Data SubjectDouble opt in: Communication Method for Parent Data SubjectDouble opt in: Communication Method for Child Data Subject
-
Select the email identifier type to which double opt in confirmation emails should be sent. This field appears when the Send confirmation email setting is enabled.
This field appears when the Allow Multiple Identifiers setting within the Configuration section on the Details tab is enabled. The name of this field can vary based on the settings enabled within the Configuration section of the Details tab. The following variations can appear:
-
If the Enable Parent-child relationship on this collection point setting is disabled, then the field name will be Communication Method for Data Subject.
-
If the Enable Parent-child relationship on this collection point setting is enabled and an email identifier type is selected in the Parent Identifier field, then the field name will be Communication Method for Parent Data Subject.
-
If the Enable Parent-child relationship on this collection point setting is enabled and an email identifier type is not selected in the Parent Identifier field, then the field name will be Communication Method for Child Data Subject.
-
- Send acknowledgement email
-
Enable this setting to send an email when consent is given for a single collection point.
- Send acknowledgement email: Preference center
-
Select the preference center for which you want to include a link in the email. This field appears when the Send acknowledgement email setting is enabled.
- Send acknowledgement email: Email
-
Select the email identifier type to which double opt in confirmation emails should be sent. This field appears when the Send acknowledgement email setting is enabled.
Events section
- Field
- Description
- Send data subject update events
-
Enable this setting to trigger an event when a consent update occurs from this collection point. Additional configuration steps will be required in Integrations.
- Send data subject update events: Per receipt
-
Select this option to trigger a single event that captures what changed when a data subject has been fully updated. This field appears when the Send data subject update events setting is enabled.
Note:This is the recommended option.
- Send data subject update events: Per transaction
-
Select this option to trigger a single event that captures what changed for each purpose (also known as transaction) when a data subject interacts with a collection point. This field appears when the Send data subject update events setting is enabled.
- Send data subject update events: Per every change
-
Select this option to trigger a single event that captures what changed when a data element, a purpose, or a purpose preference is updated through the collection point. This field appears when the Send data subject update events setting is enabled.
- Enable Collection Point Publish Events
-
Enable this setting to trigger an event each time the collection point is published. Additional configuration steps may be required in Integrations.
Records section
- Field
- Description
- Only record explicit consent choices
-
Enable this setting to track consent only when it is explicitly given through the collection point.
- Track geolocation
-
Enable this setting to enable geolocation tracking on the Collection Point in order to link it to the geolocation captured for purposes.
Note:For more information on geolocation capture, see Configuring Geolocation Capture.
Security section
- Field
- Description
- Authenticate before making changes
-
Enable this setting to create consent receipts only when accompanied by an authorization token. For more information, see Implementing the Collection Point with REST API.