Ketch

Usage Instructions

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.

Input

Parameter	Type	Required	Description
`organizationCode`	string	Yes	No description
`propertyCode`	string	Yes	No description
`environmentCode`	string	Yes	Environment code defined in Ketch (e.g., "production")
`jurisdictionCode`	string	No	Jurisdiction code (e.g., "gdpr", "ccpa")
`identities`	json	Yes	Identity map (e.g., {"email": "user@example.com"})
`purposes`	json	No	No description

Output

Parameter	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.

Input

Parameter	Type	Required	Description
`organizationCode`	string	Yes	No description
`propertyCode`	string	Yes	No description
`environmentCode`	string	Yes	Environment code defined in Ketch (e.g., "production")
`jurisdictionCode`	string	No	Jurisdiction code (e.g., "gdpr", "ccpa")
`identities`	json	Yes	Identity map (e.g., {"email": "user@example.com"})
`purposes`	json	Yes	Map of purpose codes to consent settings (e.g., {"analytics": {"allowed": "granted", "legalBasisCode": "consent_optin"}})
`collectedAt`	number	No	No description

Output

Parameter	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.

Input

Parameter	Type	Required	Description
`organizationCode`	string	Yes	No description
`propertyCode`	string	Yes	No description
`environmentCode`	string	Yes	Environment code defined in Ketch (e.g., "production")
`identities`	json	Yes	Identity map (e.g., {"email": "user@example.com"})

Output

Parameter	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.

Input

Parameter	Type	Required	Description
`organizationCode`	string	Yes	No description
`propertyCode`	string	Yes	No description
`environmentCode`	string	Yes	Environment code defined in Ketch (e.g., "production")
`identities`	json	Yes	Identity map (e.g., {"email": "user@example.com"})
`topics`	json	No	Map of topic codes to contact method settings (e.g., {"newsletter": {"email": {"status": "granted"}, "sms": {"status": "denied"}}})
`controls`	json	No	Map of control codes to settings (e.g., {"global_unsubscribe": {"status": "denied"}})

Output

Parameter	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.

Input

Parameter	Type	Required	Description
`organizationCode`	string	Yes	No description
`propertyCode`	string	Yes	No description
`environmentCode`	string	Yes	Environment code defined in Ketch (e.g., "production")
`jurisdictionCode`	string	Yes	Jurisdiction code (e.g., "gdpr", "ccpa")
`rightCode`	string	Yes	Privacy right code to invoke (e.g., "access", "delete", "correct", "restrict_processing")
`identities`	json	Yes	Identity map (e.g., {"email": "user@example.com"})
`userData`	json	No	Optional data subject information (e.g., {"email": "user@example.com", "firstName": "John", "lastName": "Doe"})

Output

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

Ketch

On this page