Klaviyo

Usage Instructions

Integrate Klaviyo into your workflow. Manage subscriber profiles, add and update list memberships, track custom events for behavioral email targeting, and retrieve campaign data for ecommerce marketing automation.

Tools

`klaviyo_get_profiles`

Retrieve profiles (subscribers) from Klaviyo with optional email filter

Input

Parameter	Type	Required	Description
`apiKey`	string	No	Klaviyo private API key
`email`	string	No	Filter profiles by email address
`pageSize`	number	No	Number of profiles to return (max 100)
`cursor`	string	No	Pagination cursor for next page

Output

Parameter	Type	Description
`profiles`	json	Array of Klaviyo profile objects
`nextCursor`	string	Cursor for next page of results
`total`	number	Total number of profiles returned

`klaviyo_create_profile`

Create a new profile (subscriber) in Klaviyo

Input

Parameter	Type	Required	Description
`apiKey`	string	No	Klaviyo private API key
`email`	string	No	Profile email address
`phoneNumber`	string	No	Profile phone number in E.164 format
`firstName`	string	No	Profile first name
`lastName`	string	No	Profile last name
`organization`	string	No	Profile organization
`title`	string	No	Profile job title
`properties`	json	No	Custom profile properties as JSON object

Output

Parameter	Type	Description
`id`	string	Klaviyo profile ID
`email`	string	Profile email address
`firstName`	string	Profile first name
`lastName`	string	Profile last name
`created`	string	Profile creation timestamp

`klaviyo_update_profile`

Update an existing profile in Klaviyo

Input

Parameter	Type	Required	Description
`apiKey`	string	No	Klaviyo private API key
`profileId`	string	No	Klaviyo profile ID to update
`email`	string	No	Updated email address
`phoneNumber`	string	No	Updated phone number in E.164 format
`firstName`	string	No	Updated first name
`lastName`	string	No	Updated last name
`organization`	string	No	Updated organization
`title`	string	No	Updated job title
`properties`	json	No	Updated custom properties as JSON object

Output

Parameter	Type	Description
`id`	string	Klaviyo profile ID
`email`	string	Profile email address
`firstName`	string	Profile first name
`lastName`	string	Profile last name
`updated`	string	Profile update timestamp

`klaviyo_track_event`

Track a custom event for a profile in Klaviyo

Input

Parameter	Type	Required	Description
`apiKey`	string	No	Klaviyo private API key
`eventName`	string	No	Name of the event to track (e.g. "Purchased Item")
`email`	string	No	Profile email address to associate the event with
`phoneNumber`	string	No	Profile phone number to associate the event with
`profileId`	string	No	Klaviyo profile ID to associate the event with
`properties`	json	No	Event properties as JSON object
`value`	number	No	Monetary value of the event
`time`	string	No	ISO 8601 timestamp of when the event occurred

Output

Parameter	Type	Description
`success`	boolean	Whether the event was tracked successfully
`eventId`	string	Klaviyo event ID
`eventName`	string	Name of the tracked event

`klaviyo_get_lists`

Retrieve all lists in a Klaviyo account

Input

Parameter	Type	Required	Description
`apiKey`	string	No	Klaviyo private API key
`pageSize`	number	No	Number of lists to return per page (max 10)

Output

Parameter	Type	Description
`lists`	json	Array of Klaviyo list objects
`total`	number	Total number of lists returned

`klaviyo_add_profiles_to_list`

Add one or more profiles to a Klaviyo list

Input

Parameter	Type	Required	Description
`apiKey`	string	No	Klaviyo private API key
`listId`	string	No	ID of the Klaviyo list to add profiles to
`emails`	string	No	Comma-separated email addresses to add to the list
`profileIds`	string	No	Comma-separated Klaviyo profile IDs to add to the list

Output

Parameter	Type	Description
`success`	boolean	Whether profiles were added successfully
`listId`	string	The Klaviyo list ID
`added`	number	Number of profiles added to the list

`klaviyo_get_campaigns`

Retrieve email or SMS campaigns from Klaviyo

Input

Parameter	Type	Required	Description
`apiKey`	string	No	Klaviyo private API key
`channel`	string	No	Campaign channel: "email" or "sms" (default: email)
`pageSize`	number	No	Number of campaigns to return per page (max 50)

Output

Parameter	Type	Description
`campaigns`	json	Array of Klaviyo campaign objects
`total`	number	Total number of campaigns returned

Klaviyo

Sur cette page