LeadConsent
Consents are used to store the permissions a lead has given us to store and process their data. Consents can be email double opt-ins, frontend checkboxes, or external consents, that are requested from another system and can later be activated via an api call from the external system to the scanleads api or directly by the end user (see activation_url and revoke_url).
Structure
id: string
Unique ID of the Consent
type: "checkbox" | "mail" | "external"
Type of the Consent. Checkbox and mail are handled internally, external consents are requested from another system and can later be activated via an api call from the external system to the scanleads api.
name: string
Custom name of the consent
status: "requested" | "active" | "revoked"
Status of the Consent.
activation_url: string | null
Url to activate a consent for a given lead. Only for external consents, null otherwise. This url can either be used by the lead directly (e.g. via their mail client) to activate the consent or by the external system to activate the consent for the lead.
revoke_url: string | null
Url to revoke a consent for a given lead. Only for external consents, null otherwise. This url can either be used by the lead directly (e.g. via their mail client) to revoke the consent or by the external system to revoke the consent for the lead.
meta: object
Example Object
{
"id": "string",
"type": "external",
"name": "Newsletter Double Opt-In",
"status": "requested",
"activation_url": "https://scanly.net/[...]",
"revoke_url": "https://scanly.net/[...]",
"meta": {
"key": "value"
}
}