Skip to content
Try for free
On this page

Integrations

Ketch

Manage privacy consent, subscriptions, and data subject rights

Use Ketch to read or update consent and subscription preferences and submit data-subject rights requests.

Add a Ketch block and provide your organization code, property code, and environment code. The Ketch Web API is a public API — no API key or OAuth credentials are required. Identity is determined by the organization and property codes along with the data subject's identity (e.g., email address).

Use the block

Retrieve and update consent preferences, manage subscription topics and controls, and submit data subject rights requests for access, deletion, correction, or processing restriction.

Actions

Ketch Get Consent

Retrieve consent status for a data subject. Returns the current consent preferences for each configured purpose.

Input

ParameterTypeRequiredDescription
organizationCodestringYesKetch organization code
propertyCodestringYesDigital property code defined in Ketch
environmentCodestringYesEnvironment code defined in Ketch (e.g., "production")
jurisdictionCodestringNoJurisdiction code (e.g., "gdpr", "ccpa")
identitiesjsonYesIdentity map (e.g., {"email": "user@example.com"})
purposesjsonNoOptional purposes to filter the consent query

Output

ParameterTypeDescription
purposesobjectMap of purpose codes to consent status and legal basis
↳ allowedstringConsent status for the purpose: "granted" or "denied"
↳ legalBasisCodestringLegal basis code (e.g., "consent_optin", "consent_optout", "disclosure", "other")
vendorsobjectMap of vendor consent statuses

Ketch Set Consent

Update consent preferences for a data subject. Sets the consent status for specified purposes with the appropriate legal basis.

Input

ParameterTypeRequiredDescription
organizationCodestringYesKetch organization code
propertyCodestringYesDigital property code defined in Ketch
environmentCodestringYesEnvironment code defined in Ketch (e.g., "production")
jurisdictionCodestringNoJurisdiction code (e.g., "gdpr", "ccpa")
identitiesjsonYesIdentity map (e.g., {"email": "user@example.com"})
purposesjsonYesMap of purpose codes to consent settings (e.g., {"analytics": {"allowed": "granted", "legalBasisCode": "consent_optin"}})
collectedAtnumberNoUNIX timestamp when consent was collected (defaults to current time)

Output

ParameterTypeDescription
purposesobjectUpdated consent status map of purpose codes to consent settings
↳ allowedstringConsent status for the purpose: "granted" or "denied"
↳ legalBasisCodestringLegal basis code (e.g., "consent_optin", "consent_optout", "disclosure", "other")

Ketch Get Subscriptions

Retrieve subscription preferences for a data subject. Returns the current subscription topic and control statuses.

Input

ParameterTypeRequiredDescription
organizationCodestringYesKetch organization code
propertyCodestringYesDigital property code defined in Ketch
environmentCodestringYesEnvironment code defined in Ketch (e.g., "production")
identitiesjsonYesIdentity map (e.g., {"email": "user@example.com"})

Output

ParameterTypeDescription
topicsobjectMap of topic codes to contact method settings (e.g., {"newsletter": {"email": {"status": "granted"}}})
controlsobjectMap of control codes to settings (e.g., {"global_unsubscribe": {"status": "denied"}})

Ketch Set Subscriptions

Update subscription preferences for a data subject. Sets topic and control statuses for email, SMS, and other contact methods.

Input

ParameterTypeRequiredDescription
organizationCodestringYesKetch organization code
propertyCodestringYesDigital property code defined in Ketch
environmentCodestringYesEnvironment code defined in Ketch (e.g., "production")
identitiesjsonYesIdentity map (e.g., {"email": "user@example.com"})
topicsjsonNoMap of topic codes to contact method settings (e.g., {"newsletter": {"email": {"status": "granted"}, "sms": {"status": "denied"}}})
controlsjsonNoMap of control codes to settings (e.g., {"global_unsubscribe": {"status": "denied"}})

Output

ParameterTypeDescription
successbooleanWhether the subscription preferences were updated

Ketch Invoke Right

Submit a data subject rights request (e.g., access, delete, correct, restrict processing). Initiates a privacy rights workflow in Ketch.

Input

ParameterTypeRequiredDescription
organizationCodestringYesKetch organization code
propertyCodestringYesDigital property code defined in Ketch
environmentCodestringYesEnvironment code defined in Ketch (e.g., "production")
jurisdictionCodestringYesJurisdiction code (e.g., "gdpr", "ccpa")
rightCodestringYesPrivacy right code to invoke (e.g., "access", "delete", "correct", "restrict_processing")
identitiesjsonYesIdentity map (e.g., {"email": "user@example.com"})
userDatajsonNoOptional data subject information (e.g., {"email": "user@example.com", "firstName": "John", "lastName": "Doe"})

Output

ParameterTypeDescription
successbooleanWhether the rights request was submitted
messagestringResponse message from Ketch
Was this helpful?
Suggest an edit