Ketch

Instructions d'utilisation

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.

Outils

`ketch_get_consent`

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

Entrée

Paramètre	Type	Obligatoire	Description
`organizationCode`	string	Oui	Ketch organization code
`propertyCode`	string	Oui	Digital property code defined in Ketch
`environmentCode`	string	Oui	Environment code defined in Ketch (e.g., "production")
`jurisdictionCode`	string	Non	Jurisdiction code (e.g., "gdpr", "ccpa")
`identities`	json	Oui	Identity map (e.g., {"email": "user@example.com"})
`purposes`	json	Non	Optional purposes to filter the consent query

Sortie

Paramètre	Type	Description
`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.

Entrée

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

Sortie

Paramètre	Type	Description
`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.

Entrée

Paramètre	Type	Obligatoire	Description
`organizationCode`	string	Oui	Ketch organization code
`propertyCode`	string	Oui	Digital property code defined in Ketch
`environmentCode`	string	Oui	Environment code defined in Ketch (e.g., "production")
`identities`	json	Oui	Identity map (e.g., {"email": "user@example.com"})

Sortie

Paramètre	Type	Description
`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.

Entrée

Paramètre	Type	Obligatoire	Description
`organizationCode`	string	Oui	Ketch organization code
`propertyCode`	string	Oui	Digital property code defined in Ketch
`environmentCode`	string	Oui	Environment code defined in Ketch (e.g., "production")
`identities`	json	Oui	Identity map (e.g., {"email": "user@example.com"})
`topics`	json	Non	Map of topic codes to contact method settings (e.g., {"newsletter": {"email": {"status": "granted"}, "sms": {"status": "denied"}}})
`controls`	json	Non	Map of control codes to settings (e.g., {"global_unsubscribe": {"status": "denied"}})

Sortie

Paramètre	Type	Description
`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.

Entrée

Paramètre	Type	Obligatoire	Description
`organizationCode`	string	Oui	Ketch organization code
`propertyCode`	string	Oui	Digital property code defined in Ketch
`environmentCode`	string	Oui	Environment code defined in Ketch (e.g., "production")
`jurisdictionCode`	string	Oui	Jurisdiction code (e.g., "gdpr", "ccpa")
`rightCode`	string	Oui	Privacy right code to invoke (e.g., "access", "delete", "correct", "restrict_processing")
`identities`	json	Oui	Identity map (e.g., {"email": "user@example.com"})
`userData`	json	Non	Optional data subject information (e.g., {"email": "user@example.com", "firstName": "John", "lastName": "Doe"})

Sortie

Paramètre	Type	Description
`success`	boolean	Whether the rights request was submitted
`message`	string	Response message from Ketch

Ketch

On this page