Send audience lists to Klaviyo

Note

This topic contains information about configuring a destination that sends query results to Klaviyo using orchestrations. To configure a destination that sends audiences to Klaviyo using campaigns see this topic .

Klaviyo is an email platform for targeting, personalizing, measuring, and optimizing email and Facebook campaigns.

Use Amperity to manage audience lists in Klaviyo. Build a query using the email field, with optional additional customer profile fields, and then send the results of that query to Klaviyo. The audience list will be updated to match the query.

Note

This destination uses the Klaviyo REST API .

Amperity uses the Update Profile endpoint in the Klaviyo REST API to send customer profile attributes to Klaviyo.

Review the rate limits that are applied to endpoints in the Klaviyo REST API to manage customer profiles.

Before sending a set of customer profiles to Klaviyo, and to help set expectations, you should review the rate limits and estimate the amount of time required to complete the process of adding your set of customer profiles to Klaviyo.

Get details

Review the following details before configuring credentials for Klaviyo and before configuring Amperity to send audience lists to Klaviyo.

Credential settings API key Required Required. The API key for your Klaviyo account. The private API key that is used for authentication must have the following scopes added: lists:write profiles:write

Configure credentials

Configure credentials for Klaviyo before adding a destination.

An individual with access to Klaviyo should use SnapPass to securely share “API key” details with the individual who will configure Amperity.

To configure credentials for Klaviyo

	From the Settings page, select the Credentials tab, and then click the Add credential button.
	In the Credentials settings dialog box, do the following: From the Plugin dropdown, select Klaviyo. Assign the credential a name and description that ensures other users of Amperity can recognize when to use this destination.
	The settings that are available for a credential are determined by the credential type. For the “klaviyo” credential type, configure settings, and then click Save. API key Required Required. The API key for your Klaviyo account.

Add destination

Use a sandbox to configure a destination for Klaviyo. Before promoting your changes, send a test audience, and then verify the the results in Klaviyo. After the end-to-end workflow has been verified, push the destination from the sandbox to production.

To add a destination for Klaviyo

	Open the Destinations page, and then click the Add destination button. To configure a destination for Klaviyo, do one of the following: Click the row in which Klaviyo is located. Destinations are listed alphabetically and you can scroll up and down the list. Search for Klaviyo. Start typing “klav”. The list will filter to show only matching destinations. Select “Klaviyo”.
	Select the credential for Klaviyo from the Credential drop-down, and then click Continue. Tip Click the “Test connection” link on the “Configure destination” page to verify that Amperity can connect to Klaviyo.
	In the “Destination settings” dialog box, assign the destination a name and description that ensures other users of Amperity can recognize when to use this destination. Configure business user access By default a destination is available to all users who have permission to view personally identifiable information (PII). Enable the Admin only checkbox to restrict access to only users assigned to the Datagrid Operator and Datagrid Administrator policies. Enable the PII setting checkbox to allow users with limited access to PII access to this destination. Restricted PII access is enabled when the Restrict PII access policy option that prevents users who are assigned to that option from viewing data that is marked as PII anywhere in Amperity and from sending that data to any downstream workflow.
	Configure the following settings, and then click “Save”. List name (Required at orchestration) The list name to which Amperity will write the audience list. This can be the name of an existing list or a new list. Klaviyo supports up to 1000 lists and/or segments in your account at any given time. Update contacts The name of the list in Klaviyo that is managed by Amperity. This list will be created by Amperity if it does not exist. Audience primary key The primary key for the audience. Set to “email”.
	After this destination is configured, users may configure Amperity to: Use orchestrations to send query results Use orchestrations and campaigns to send audiences Use orchestrations and campaigns to send offline events to Klaviyo.

Workflow actions

A workflow will occasionally show an error that describes what prevented a workflow from completing successfully. These first appear as alerts in the notifications pane. The alert describes the error, and then links to the Workflows tab.

Open the Workflows page to review a list of workflow actions, choose an action to resolve the workflow error, and then follow the steps that are shown.

	You may receive a notifications error for a configured Klaviyo destination. This appears as an alert in the notifications pane on the Destinations tab. If you receive a notification error, review the details, and then click the View Workflow link to open this notification error in the Workflows page.
	On the Workflows page, review the individual steps to determine which step(s) have errors that require your attention, and then click Show Resolutions to review the list of workflow actions that were generated for this error.
	A list of individual workflow actions are shown. Review the list to identify which action you should take. Some workflow actions are common across workflows and will often be available, such as retrying a specific task within a workflow or restarting a workflow. These types of actions can often resolve an error. In certain cases, actions are specific and are shown when certain conditions exist in your tenant. These types of actions typically must be resolved and may require steps that must be done upstream or downstream from your Amperity workflow. Amperity provides a series of workflow actions that can help resolve specific issues that may arise with Klaviyo, including: Invalid credentials Maximum number of lists exceeded
	Select a workflow action from the list of actions, and then review the steps for resolving that error. After you have completed the steps in the workflow action, click Continue to rerun the workflow.

Invalid credentials

The credentials that are defined in Amperity are invalid.

To resolve this error, verify that the credentials required by this workflow are valid.

1. Open the Credentials page.

2. Review the details for the credentials used with this workflow. Update the credentials for Klaviyo if required.

3. Return to the workflow action, and then click Resolve to retry this workflow.

Maximum number of lists exceeded

Klaviyo supports up to 1000 lists and/or segments in your account at any given time.

To resolve this error, verify the number of lists and/or segments associated with your Klaviyo account.

1. Log into Klaviyo and verify the number of lists and/or segments that are associated with your Klaviyo account.

2. Remove unused lists and/or segments.

3. Return to the workflow action, and then click Resolve to retry this workflow.

Customer profile parameters

The following table describes the parameters that may be sent to Klaviyo. Use the properties field to define a series of custom properties (as key/value pairs) to represent offline events.

Amperity uses the Update Profile endpoint in the Klaviyo API to send customer profile attributes to Klaviyo.

The list of customer profile parameters supported by Klaviyo are described in the following table. Parameters are listed alphabetically, but may be returned in any order.

Field name	Description
address1	Optional The address that is associated with the location of a customer, such as “123 Main Street”.
address2	Optional Additional address information, such as an apartment number or a post office box, that is associated with the location of a customer, such as “Apt #9”.
city	Optional The city that is associated with the location of a customer.
country	Optional The country that is associated with the location of a customer.
email	Required The email address that is associated with a customer. A customer may have more than one email address. Important An email address is used by Klaviyo to generate a unique customer identifier for each customer profile that exists within Klaviyo. This email address is most often found in the email field in the Merged Customers table, but may be located elsewhere depending on how your brand has configured your customer 360 database and depending on the downstream use cases your brand wants to enable within Klaviyo.
external_id	Optional A unique identifier that associates Klaviyo profiles with customer profiles that exist within an external system. For example, a unique ID for a point-of-sale system or the Amperity ID.
first_name	Optional The first name that is associated with a customer.
image	Optional A URL that points to the location of a profile image for this customer profile.
ip	Optional An IP address that is associated with this customer profile.
last_event_date	Optional A timestamp for an event that is associated with this customer profile. For example, the date and time of the most recent transaction from your brand’s website or store.
last_name	Optional The last name that is associated with a customer.
latitude	Optional A latitude coordinate that may be used to define location-based segments in Klaviyo. Note This value should have a precision of four decimal places.
longitude	Optional A longitude coordinate that may be used to define location-based segments in Klaviyo. Note This value should have a precision of four decimal places.
organization	Optional The company, typically an employer or small business, that is associated with a customer.
phone_number	Optional The phone number that is associated with a customer. A customer may have more than one phone number. Note A phone number must be in E.164 format, which represents a phone number as a number up to fifteen digits in length (without spaces) that starts with a + symbol. For example: +12061234567.
properties	Optional A series of custom properties represented as key/value pairs for additional data that your brand wants to associate with this customer profile. For example, a store ID or the name (or SKU) of the most recent product purchase associated with this customer profile.
region	Optional The state or province that is associated with the location of a customer.
timezone	Optional The name of a timezome. Klaviyo recommends using the name of a timezone in the IANA Time Zone Database.
title	Optional The title that precedes a full name that is associated with a customer, such as “Mr.”, “Mrs”, and “Dr”.
zip	Optional The zip code or postal code that is associated with the location of a customer.