Klaviyo Integration
Overview
An e-commerce marketing automation platform providing email and SMS marketing.
Add Profile to List
Create Profile
Get Profiles
Get Segment Profiles
Update Profile
Subscribe Profile to List
Add Profile to List
Add a profile to a specific list in your Klaviyo account.
Appended Fields
Klaviyo will append the following data to your lead.
Appended Field | Description |
---|---|
Outcome | Integration outcome (success, failure, or error) |
Reason | If integration fails, this is the reason why |
Errors Id | Array of error ids |
Errors Code | Array of error codes |
Errors Title | Array of error titles |
Errors Detail | Array of error descriptions |
Fields
The following fields are used by this integration and automatically added to your flow when missing.
Field | Description |
---|---|
Email | Individual's email address |
Phone 1 | Individual's phone number |
Custom Input Variables
The following are configuration options (typically not collected with lead data).
Variable | Description |
---|---|
Klaviyo List Id | Klaviyo List ID used to identify which list to add profiles to. |
Klaviyo Id | Klaviyo Profile ID used to uniquely identify a profile in your account. |
Klaviyo External Id | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. |
Klaviyo Identifier | Field to use as an identifier for the Profile search action. Either "email", "phone_number", "klaviyo_id", or "external_id". |
Klaviyo Profile Handling | Which profile to update when multiple are found; it can be one of the following: "earliest creation date", "earliest update date", "newest creation date", or "newest update date". |
Timeout Seconds | Produce an "error" outcome if the server fails to respond within this number of seconds (default: 360) |
Create Profile
Create a new profile in your Klaviyo account.
Appended Fields
Klaviyo will append the following data to your lead.
Appended Field | Description |
---|---|
Outcome | Integration outcome (success, failure, or error) |
Reason | If integration fails, this is the reason why |
Type | |
Id | Primary key that uniquely identifies this profile. Generated by Klaviyo |
Reference | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. |
Anonymous Id | Anonymous key that uniquely identifies this profile. |
List Name | A helpful name to label the list |
Created Time | Date and time when the profile was created |
Updated Time | Date and time when the profile was last updated |
Last Event Date | Date and time of the most recent event the triggered an update to the profile |
Custom * | Custom Klaviyo field |
Email Marketing Consent Status | The consent status for email marketing |
Email Marketing Subscription Method | The method by which the profile was subscribed to email marketing |
Email Marketing Subscription Suppression Reason | The reason the profile was suppressed from the list |
Email Marketing Subscription Suppression Timestamp | The timestamp when the profile was suppressed from the list |
Email Marketing Suppression List Id | The ID of list to which the suppression applies |
Email Marketing Suppression List Reason | The reason the profile was suppressed from the list |
Email Marketing Suppression List Timestamp | The timestamp when the profile was suppressed from the list |
Sms Marketing Consent Status | The consent status for SMS marketing |
Sms Marketing Timestamp | The timestamp when consent record or updated for SMS marketing |
Sms Marketing Method | The method by which the profile was subscribed to SMS marketing |
Sms Marketing Method Details | Additional details about the method which the profile was subscribed to SMS marketing |
Self Links | The profile URI |
Errors Id | Array of error ids |
Errors Code | Array of error codes |
Errors Title | Array of error titles |
Errors Detail | Array of error descriptions |
Fields
The following fields are used by this integration and automatically added to your flow when missing.
Field | Description |
---|---|
Email | Individual's email address |
Phone 1 | Individual's phone number |
Reference | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. |
First Name | Individual's first name |
Last Name | Individual's last name |
Company Name | Name of the company or organization within the company for whom the individual works |
Title | Individual's job title |
Address 1 | First line of street address |
Address 2 | Second line of street address |
City | City name |
Country | Country name |
Latitude | Latitude coordinate |
Longitude | Longitude coordinate |
State | Region within a country, such as state or province |
Postal Code | Zip code |
Custom Input Variables
The following are configuration options (typically not collected with lead data).
Variable | Description |
---|---|
Klaviyo Photo Url | URL pointing to the location of a profile image |
Klaviyo Timezone | Time zone name |
Klaviyo Custom | |
Timeout Seconds | Produce an "error" outcome if the server fails to respond within this number of seconds (default: 360) |
Get Profiles
Identify if a profile exists in your Klaviyo account.
Appended Fields
Klaviyo will append the following data to your lead.
Appended Field | Description |
---|---|
Outcome | Integration outcome (success, failure, or error) |
Reason | If integration fails, this is the reason why |
Type | |
Id | Primary key that uniquely identifies this profile. Generated by Klaviyo |
Reference | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. |
Anonymous Id | Anonymous key that uniquely identifies this profile. |
List Name | A helpful name to label the list |
Created Time | Date and time when the profile was created |
Updated Time | Date and time when the profile was last updated |
Last Event Date | Date and time of the most recent event the triggered an update to the profile |
Custom * | Custom Klaviyo field |
Email Marketing Consent Status | The consent status for email marketing |
Email Marketing Subscription Method | The method by which the profile was subscribed to email marketing |
Email Marketing Subscription Suppression Reason | The reason the profile was suppressed from the list |
Email Marketing Subscription Suppression Timestamp | The timestamp when the profile was suppressed from the list |
Email Marketing Suppression List Id | The ID of list to which the suppression applies |
Email Marketing Suppression List Reason | The reason the profile was suppressed from the list |
Email Marketing Suppression List Timestamp | The timestamp when the profile was suppressed from the list |
Sms Marketing Consent Status | The consent status for SMS marketing |
Sms Marketing Timestamp | The timestamp when consent record or updated for SMS marketing |
Sms Marketing Method | The method by which the profile was subscribed to SMS marketing |
Sms Marketing Method Details | Additional details about the method which the profile was subscribed to SMS marketing |
Self Links | The profile URI |
Errors Id | Array of error ids |
Errors Code | Array of error codes |
Errors Title | Array of error titles |
Errors Detail | Array of error descriptions |
Fields
The following fields are used by this integration and automatically added to your flow when missing.
Field | Description |
---|---|
Email | Individual's email address |
Phone 1 | Individual's phone number |
Custom Input Variables
The following are configuration options (typically not collected with lead data).
Variable | Description |
---|---|
Klaviyo Id | Klaviyo Profile ID used to uniquely identify a profile in your account. |
Klaviyo External Id | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. |
Klaviyo Identifier | Field to use as an identifier for the Profile search action. Either "email", "phone_number", "klaviyo_id", or "external_id". |
Klaviyo Profile Handling | Which profile to update when multiple are found; it can be one of the following: "earliest creation date", "earliest update date", "newest creation date", or "newest update date". |
Timeout Seconds | Produce an "error" outcome if the server fails to respond within this number of seconds (default: 360) |
Get Segment Profiles
Check if a profile is within a specific segment in your Klaviyo account.
Appended Fields
Klaviyo will append the following data to your lead.
Appended Field | Description |
---|---|
Outcome | Integration outcome (success, failure, or error) |
Reason | If integration fails, this is the reason why |
Type | |
Id | Primary key that uniquely identifies this profile. Generated by Klaviyo |
Reference | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. |
Anonymous Id | Anonymous key that uniquely identifies this profile. |
List Name | A helpful name to label the list |
Created Time | Date and time when the profile was created |
Updated Time | Date and time when the profile was last updated |
Last Event Date | Date and time of the most recent event the triggered an update to the profile |
Custom * | Custom Klaviyo field |
Email Marketing Consent Status | The consent status for email marketing |
Email Marketing Subscription Method | The method by which the profile was subscribed to email marketing |
Email Marketing Subscription Suppression Reason | The reason the profile was suppressed from the list |
Email Marketing Subscription Suppression Timestamp | The timestamp when the profile was suppressed from the list |
Email Marketing Suppression List Id | The ID of list to which the suppression applies |
Email Marketing Suppression List Reason | The reason the profile was suppressed from the list |
Email Marketing Suppression List Timestamp | The timestamp when the profile was suppressed from the list |
Sms Marketing Consent Status | The consent status for SMS marketing |
Sms Marketing Timestamp | The timestamp when consent record or updated for SMS marketing |
Sms Marketing Method | The method by which the profile was subscribed to SMS marketing |
Sms Marketing Method Details | Additional details about the method which the profile was subscribed to SMS marketing |
Self Links | The profile URI |
Errors Id | Array of error ids |
Errors Code | Array of error codes |
Errors Title | Array of error titles |
Errors Detail | Array of error descriptions |
Fields
The following fields are used by this integration and automatically added to your flow when missing.
Field | Description |
---|---|
Email | Individual's email address |
Phone 1 | Individual's phone number |
Custom Input Variables
The following are configuration options (typically not collected with lead data).
Variable | Description |
---|---|
Klaviyo Segment Id | Klaviyo Segment ID used to identify in which segment to search for profiles. |
Klaviyo Id | Klaviyo Profile ID used to uniquely identify a profile in your account. |
Klaviyo External Id | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. |
Klaviyo Identifier | Field to use as an identifier for the Profile search action. Either "email", "phone_number", "klaviyo_id", or "external_id". |
Klaviyo Profile Handling | Which profile to update when multiple are found; it can be one of the following: "earliest creation date", "earliest update date", "newest creation date", or "newest update date". |
Timeout Seconds | Produce an "error" outcome if the server fails to respond within this number of seconds (default: 360) |
Update Profile
Update a profile in your Klaviyo account.
Appended Fields
Klaviyo will append the following data to your lead.
Appended Field | Description |
---|---|
Outcome | Integration outcome (success, failure, or error) |
Reason | If integration fails, this is the reason why |
Type | |
Id | Primary key that uniquely identifies this profile. Generated by Klaviyo |
Reference | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. |
Anonymous Id | Anonymous key that uniquely identifies this profile. |
List Name | A helpful name to label the list |
Created Time | Date and time when the profile was created |
Updated Time | Date and time when the profile was last updated |
Last Event Date | Date and time of the most recent event the triggered an update to the profile |
Custom * | Custom Klaviyo field |
Email Marketing Consent Status | The consent status for email marketing |
Email Marketing Subscription Method | The method by which the profile was subscribed to email marketing |
Email Marketing Subscription Suppression Reason | The reason the profile was suppressed from the list |
Email Marketing Subscription Suppression Timestamp | The timestamp when the profile was suppressed from the list |
Email Marketing Suppression List Id | The ID of list to which the suppression applies |
Email Marketing Suppression List Reason | The reason the profile was suppressed from the list |
Email Marketing Suppression List Timestamp | The timestamp when the profile was suppressed from the list |
Sms Marketing Consent Status | The consent status for SMS marketing |
Sms Marketing Timestamp | The timestamp when consent record or updated for SMS marketing |
Sms Marketing Method | The method by which the profile was subscribed to SMS marketing |
Sms Marketing Method Details | Additional details about the method which the profile was subscribed to SMS marketing |
Self Links | The profile URI |
Errors Id | Array of error ids |
Errors Code | Array of error codes |
Errors Title | Array of error titles |
Errors Detail | Array of error descriptions |
Fields
The following fields are used by this integration and automatically added to your flow when missing.
Field | Description |
---|---|
Email | Individual's email address |
Phone 1 | Individual's phone number |
Reference | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. |
First Name | Individual's first name |
Last Name | Individual's last name |
Company Name | Name of the company or organization within the company for whom the individual works |
Title | Individual's job title |
Address 1 | First line of street address |
Address 2 | Second line of street address |
City | City name |
Country | Country name |
Latitude | Latitude coordinate |
Longitude | Longitude coordinate |
State | Region within a country, such as state or province |
Postal Code | Zip code |
Custom Input Variables
The following are configuration options (typically not collected with lead data).
Variable | Description |
---|---|
Klaviyo Photo Url | URL pointing to the location of a profile image |
Klaviyo Timezone | Time zone name |
Klaviyo Custom | |
Timeout Seconds | Produce an "error" outcome if the server fails to respond within this number of seconds (default: 360) |
Klaviyo Id | Klaviyo Profile ID used to uniquely identify a profile in your account. |
Klaviyo External Id | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. |
Klaviyo Identifier | Field to use as an identifier for the Profile search action. Either "email", "phone_number", "klaviyo_id", or "external_id". |
Klaviyo Profile Handling | Which profile to update when multiple are found; it can be one of the following: "earliest creation date", "earliest update date", "newest creation date", or "newest update date". |
Subscribe Profile to List
Subscribe a profile to email marketing, SMS marketing, or both.
Appended Fields
Klaviyo will append the following data to your lead.
Appended Field | Description |
---|---|
Outcome | Integration outcome (success, failure, or error) |
Reason | If integration fails, this is the reason why |
Errors Id | Array of error ids |
Errors Code | Array of error codes |
Errors Title | Array of error titles |
Errors Detail | Array of error descriptions |
Fields
The following fields are used by this integration and automatically added to your flow when missing.
Field | Description |
---|---|
Email | Individual's email address |
Phone 1 | Individual's phone number |
Custom Input Variables
The following are configuration options (typically not collected with lead data).
Variable | Description |
---|---|
Klaviyo List Id | Klaviyo List ID used to identify which list to add profiles to. |
Klaviyo Channels | Klaviyo marketing channels to subscribe the profile to. Examples: "email" and "sms". |
Klaviyo Custom Source | A custom method detail or source to store on the consent records. Examples: "Marketing event". |
Klaviyo Id | Klaviyo Profile ID used to uniquely identify a profile in your account. |
Klaviyo External Id | A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. |
Klaviyo Identifier | Field to use as an identifier for the Profile search action. Either "email", "phone_number", "klaviyo_id", or "external_id". |
Klaviyo Profile Handling | Which profile to update when multiple are found; it can be one of the following: "earliest creation date", "earliest update date", "newest creation date", or "newest update date". |
Timeout Seconds | Produce an "error" outcome if the server fails to respond within this number of seconds (default: 360) |