klaviyo_suppress_profile
Globally suppress a Klaviyo profile to unsubscribe from all communications.
klaviyo_suppress_profile(context: dict, email: str) -> dictGlobally suppresses a Klaviyo profile, unsubscribing the email address from all communications.
Requires the Klaviyo integration to be installed for the business.
Parameters
| Name | Type | Description |
|---|---|---|
context | dict | The context object passed to your action |
email | str | The customer's email address |
Returns
dict — {"success": true}
Examples
Unsubscribe a customer who requests it
def execute_action(context):
email = context["args"]["email"]
klaviyo_suppress_profile(context, email)
return {"success": True, "message": "You've been unsubscribed from all communications."}