Ketch

Nutzungsanweisungen

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

Tools

`ketch_get_consent`

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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`organizationCode`	string	Ja	Ketch organization code
`propertyCode`	string	Ja	Digital property code defined in Ketch
`environmentCode`	string	Ja	Environment code defined in Ketch (e.g., "production")
`jurisdictionCode`	string	Nein	Jurisdiction code (e.g., "gdpr", "ccpa")
`identities`	json	Ja	Identity map (e.g., {"email": "user@example.com"})
`purposes`	json	Nein	Optional purposes to filter the consent query

Ausgabe

Parameter	Typ	Beschreibung
`purposes`	object	Map of purpose codes to consent status and legal basis
↳ `allowed`	string	Consent status for the purpose: "granted" or "denied"
↳ `legalBasisCode`	string	Legal basis code (e.g., "consent_optin", "consent_optout", "disclosure", "other")
`vendors`	object	Map 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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`organizationCode`	string	Ja	Ketch organization code
`propertyCode`	string	Ja	Digital property code defined in Ketch
`environmentCode`	string	Ja	Environment code defined in Ketch (e.g., "production")
`jurisdictionCode`	string	Nein	Jurisdiction code (e.g., "gdpr", "ccpa")
`identities`	json	Ja	Identity map (e.g., {"email": "user@example.com"})
`purposes`	json	Ja	Map of purpose codes to consent settings (e.g., {"analytics": {"allowed": "granted", "legalBasisCode": "consent_optin"}})
`collectedAt`	number	Nein	UNIX timestamp when consent was collected (defaults to current time)

Ausgabe

Parameter	Typ	Beschreibung
`purposes`	object	Updated consent status map of purpose codes to consent settings
↳ `allowed`	string	Consent status for the purpose: "granted" or "denied"
↳ `legalBasisCode`	string	Legal 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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`organizationCode`	string	Ja	Ketch organization code
`propertyCode`	string	Ja	Digital property code defined in Ketch
`environmentCode`	string	Ja	Environment code defined in Ketch (e.g., "production")
`identities`	json	Ja	Identity map (e.g., {"email": "user@example.com"})

Ausgabe

Parameter	Typ	Beschreibung
`topics`	object	Map of topic codes to contact method settings (e.g., {"newsletter": {"email": {"status": "granted"}}})
`controls`	object	Map 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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`organizationCode`	string	Ja	Ketch organization code
`propertyCode`	string	Ja	Digital property code defined in Ketch
`environmentCode`	string	Ja	Environment code defined in Ketch (e.g., "production")
`identities`	json	Ja	Identity map (e.g., {"email": "user@example.com"})
`topics`	json	Nein	Map of topic codes to contact method settings (e.g., {"newsletter": {"email": {"status": "granted"}, "sms": {"status": "denied"}}})
`controls`	json	Nein	Map of control codes to settings (e.g., {"global_unsubscribe": {"status": "denied"}})

Ausgabe

Parameter	Typ	Beschreibung
`success`	boolean	Whether 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.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`organizationCode`	string	Ja	Ketch organization code
`propertyCode`	string	Ja	Digital property code defined in Ketch
`environmentCode`	string	Ja	Environment code defined in Ketch (e.g., "production")
`jurisdictionCode`	string	Ja	Jurisdiction code (e.g., "gdpr", "ccpa")
`rightCode`	string	Ja	Privacy right code to invoke (e.g., "access", "delete", "correct", "restrict_processing")
`identities`	json	Ja	Identity map (e.g., {"email": "user@example.com"})
`userData`	json	Nein	Optional data subject information (e.g., {"email": "user@example.com", "firstName": "John", "lastName": "Doe"})

Ausgabe

Parameter	Typ	Beschreibung
`success`	boolean	Whether the rights request was submitted
`message`	string	Response message from Ketch

Ketch

On this page