Klaviyo Component
Klaviyo is a cloud based email marketing solution that enables e-commerce businesses to create, send, and analyze email and SMS campaigns.
Component key: klaviyo
Description
Klaviyo is a cloud based email marketing solution that enables e-commerce businesses to create, send, and analyze email and SMS campaigns.
Use the component to manage Templates, Campaigns, Events, and more.
API Documentation: The component was built using the Klaviyo API Reference
Connections
API Key
Authentication was developed using the following Documentation
Private keys will have the prefix pk_ followed by a longer alphanumeric string. Klaviyo allows you to generate multiple private keys for your applications. See the Obtain API credentials guide for more information
To Generate a Private Key:
- Log into your Klaviyo account and navigate to settings
- Under the Account tab select API Keys
- Select Create Private API Key
- Name the Key, provide the proper scope level and select Create
- Save and copy the private key into your integration connection configuration.
| Input | Notes | Example |
|---|---|---|
| API Key | Your API Key for Klaviyo |
OAuth 2.0
Authentication was developed using the following Documentation
OAuth configuration requires setting up an app in Klaviyo. See the Set up OAuth guide for more information:
- Log into your Klaviyo account and navigate to the Manage apps page.
- Select Create App
- Name the app and copy your Client ID and Client Secret and enter them into the connection configuration of your integration
- Save and continue to proceed
- Once creation has been completed enter the the following into the Redirect URL field:
https://oauth2.prismatic.io/callbackand save. - Select Review Submission to submit the app for completion.
| Input | Notes | Example |
|---|---|---|
| Authorize URL | https://www.klaviyo.com/oauth/authorize | |
| Client ID | ||
| Client secret | ||
| Scopes | Space separated list of scopes if needed | |
| Token URL | https://a.klaviyo.com/oauth/token |
Data Sources
Select Account
Select an account to use. | key: selectAccount | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Select Campaign
Select a campaign to use. | key: selectCampaign | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Select Event
Select an event to use. | key: selectEvent | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Select Profile
Select a profile to use. | key: selectProfile | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Select Template
Select a template to use. | key: selectTemplate | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Actions
Bulk Create Events
Create a batch of events for one or more profiles. | key: bulkCreateEvents
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Events Array | An array of events to create. |
{
"data": "Events created successfully."
}
Create Campaign
Creates a campaign given a set of parameters, then returns it. | key: createCampaign
| Input | Notes | Example |
|---|---|---|
| Campaign Messages | The message(s) to send in the campaign. | |
| Campaign Name | The name of the campaign. | My new campaign |
| Connection | ||
| Excluded Audiences | A list of excluded audiences. | X7MYfE |
| Included Audiences | A list of included audiences. | X7MYfE |
| Send Options | The send options for the campaign. | |
| Send Strategy | The send strategy for the campaign. | |
| Tracking Options | The tracking options for the campaign. |
{
"data": {
"data": {
"type": "campaign",
"id": "string",
"attributes": {
"name": "string",
"status": "string",
"archived": true,
"audiences": {
"included": [
"Y6nRLr"
],
"excluded": [
"UTd5ui"
]
},
"sendOptions": {
"useSmartSending": true
},
"trackingOptions": {
"isAddUtm": true,
"utmParams": [
{
"name": "utm_medium",
"value": "campaign"
}
],
"isTrackingClicks": true,
"isTrackingOpens": true
},
"sendStrategy": {
"method": "static",
"optionsStatic": {
"datetime": "2025-11-11T19:36:47.922Z",
"isLocal": true,
"sendPastRecipientsImmediately": true
},
"optionsThrottled": {
"datetime": "2025-11-11T19:36:47.922Z",
"throttlePercentage": 0
},
"optionsSto": {
"date": "2024-07-14"
}
},
"createdAt": "2025-11-11T19:36:47.922Z",
"scheduledAt": "2025-11-11T19:36:47.922Z",
"updatedAt": "2025-11-11T19:36:47.922Z",
"sendTime": "2025-11-11T19:36:47.922Z"
},
"relationships": {
"campaignMessages": {
"data": [
{
"type": "campaign-message",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
},
"tags": {
"data": [
{
"type": "tag",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
}
},
"links": {
"self": "string"
}
}
}
}
Create Event
Create a new event to track a profiles activity. | key: createEvent
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Event Name | Name of the event. | Viewed Product |
| Event Profile | The profile associated with this event. | |
| Event Properties | The properties of the event. | |
| Event Time | When this event occurred. By default, the time the request was received will be used. | 2024-07-10T14:48:00.000Z |
| Event Unique ID | A unique identifier for this event. | 123 |
| Event Value | A numeric, monetary value to associate with this event. | 10 |
| Event Value Currency | The ISO 4217 currency code of the value associated with the event. | USD |
{
"data": "Event created successfully."
}
Create List
Create a new list. | key: createList
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| List Name | A helpful name to label the list. | Newsletter |
{
"data": {
"data": {
"type": "list",
"id": "Y6nRLr",
"attributes": {
"name": "Newsletter",
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z",
"optInProcess": "double_opt_in"
},
"relationships": {
"profiles": {
"data": [
{
"type": "profile",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
},
"tags": {
"data": [
{
"type": "tag",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
}
},
"links": {
"self": "string"
}
}
}
}
Create Profile
Create a new profile. | key: createProfile
| Input | Notes | Example |
|---|---|---|
| Connection | ||
Individual's email address | sarah.mason@klaviyo-demo.com | |
| 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. Format varies based on the external system. | 12345 |
| First Name | Individual's first name | Sarah |
| Image | URL pointing to the location of a profile image | https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg |
| Last Name | Individual's last name | Mason |
| Location | Location information for the profile. | |
| Organization | Name of the company or organization within the company for whom the individual works | Example Corporation |
| Phone Number | Individual's phone number in E.164 format | +15005550006 |
| Properties | An object containing key/value pairs for any custom properties assigned to this profile. | |
| Title | Individual's job title | Regional Manager |
{
"data": {
"data": {
"type": "profile",
"id": "01GDDKASAP8TKDDA2GRZDSVP4H",
"attributes": {
"email": "sarah.mason@klaviyo-demo.com",
"phoneNumber": "+15005550006",
"externalId": "string",
"firstName": "Sarah",
"lastName": "Mason",
"organization": "Example Corporation",
"locale": "en-US",
"title": "Regional Manager",
"image": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z",
"lastEventDate": "2022-11-08T00:00:00.000Z",
"location": {
"address1": "89 E 42nd St",
"address2": "1st floor",
"city": "New York",
"country": "United States",
"latitude": "string",
"longitude": "string",
"region": "NY",
"zip": "10017",
"timezone": "America/New_York",
"ip": "127.0.0.1"
},
"properties": {
"pseudonym": "Dr. Octopus"
},
"subscriptions": {
"email": {
"marketing": {
"canReceiveEmailMarketing": true,
"consent": "SUBSCRIBED",
"consentTimestamp": "2023-02-21T20:07:38.000Z",
"lastUpdated": "2023-02-21T20:07:38.000Z",
"method": "PREFERENCE_PAGE",
"methodDetail": "mydomain.com/signup",
"customMethodDetail": "marketing drive",
"doubleOptin": true,
"suppression": [
{
"reason": "HARD_BOUNCE",
"timestamp": "2023-02-21T20:07:38.000Z"
}
],
"listSuppressions": [
{
"listId": "Y6nRLr",
"reason": "USER_SUPPRESSED",
"timestamp": "2023-02-21T20:07:38.000Z"
}
]
}
},
"sms": {
"marketing": {
"canReceiveSmsMarketing": true,
"consent": "SUBSCRIBED",
"consentTimestamp": "2023-02-21T20:07:38.000Z",
"method": "TEXT",
"methodDetail": "JOIN",
"lastUpdated": "2023-02-21T20:07:38.000Z"
}
}
},
"predictiveAnalytics": {
"historicClv": 93.87,
"predictedClv": 27.24,
"totalClv": 121.11,
"historicNumberOfOrders": 2,
"predictedNumberOfOrders": 0.54,
"averageDaysBetweenOrders": 189,
"averageOrderValue": 46.94,
"churnProbability": 0.89,
"expectedDateOfNextOrder": "2022-11-08T00:00:00.000Z"
}
},
"relationships": {
"lists": {
"data": [
{
"type": "list",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
},
"segments": {
"data": [
{
"type": "segment",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
}
},
"links": {
"self": "string"
}
}
}
}
Create Segment
Create a segment. | key: createSegment
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Is Starred Segment | Whether the segment is starred. | false |
| Segment Condition Groups | The condition groups that define the segment. | |
| Segment Name | The name of the segment. | A segment |
{
"data": {
"data": {
"type": "segment",
"id": "string",
"attributes": {
"name": "Repeat Purchasers",
"definition": {
"conditionGroups": [
{
"conditions": [
{
"type": "profile-group-membership",
"groupIds": [
"string"
],
"timeframeFilter": {
"type": "date",
"operator": "after",
"date": "2022-11-08T00:00:00.000Z"
},
"isMember": true
},
{
"type": "profile-metric",
"metricId": "string",
"measurement": "count",
"measurementFilter": {
"type": "numeric",
"operator": "equals",
"value": 0
},
"timeframeFilter": {
"type": "date",
"operator": "after",
"date": "2022-11-08T00:00:00.000Z"
},
"metricFilters": [
{
"property": "string",
"filter": {
"type": "string",
"operator": "equals",
"value": "string"
}
}
]
},
{
"type": "profile-marketing-consent",
"consent": {
"channel": "email",
"consentStatus": {
"subscription": "any"
},
"canReceiveMarketing": true
}
},
{
"type": "profile-postal-code-distance",
"countryCode": "string",
"postalCode": "string",
"unit": "kilometers",
"filter": {
"type": "numeric",
"operator": "greater-than",
"value": 0
}
},
{
"type": "profile-property",
"property": "string",
"filter": {
"type": "string",
"operator": "contains",
"value": "string"
}
},
{
"type": "profile-region",
"inRegion": true,
"region": "european_union"
},
{
"type": "profile-predictive-analytics",
"dimension": "average_days_between_orders",
"filter": {
"type": "numeric",
"operator": "equals",
"value": 0
}
},
{
"type": "profile-predictive-analytics",
"dimension": "predicted_gender",
"filter": {
"type": "string",
"operator": "equals",
"value": "likely_female"
}
}
]
}
]
},
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z",
"isActive": true,
"isProcessing": true,
"isStarred": true
},
"relationships": {
"profiles": {
"data": [
{
"type": "profile",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
},
"tags": {
"data": [
{
"type": "tag",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
}
},
"links": {
"self": "string"
}
}
}
}
Create Template
Create a new custom HTML template. | key: createTemplate
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Editor Type | Restricted to CODE. | CODE |
| Template HTML | The HTML content of the template. | <html><body><p>Hello, world!</p></body></html> |
| Template Name | The name of the template. | Monthly Newsletter Template |
| Template Text | The text content of the template. | Hello, world! |
{
"data": {
"data": {
"type": "template",
"id": "string",
"attributes": {
"name": "string",
"editorType": "string",
"html": "string",
"text": "string",
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z"
},
"links": {
"self": "string"
}
}
}
}
Delete Campaign
Delete a campaign with the given campaign ID. | key: deleteCampaign
| Input | Notes | Example |
|---|---|---|
| Campaign ID | The ID of the campaign. | 01J2DNH88028WCAA2RK0BYBZVG |
| Connection |
Delete List
Delete a list with the given list ID. | key: deleteList
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| List ID | The unique identifier of the list. | RE83th |
Delete Segment
Delete a segment with the given segment ID. | key: deleteSegment
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Segment ID | The ID of the segment. | WwKnkd |
Delete Template
Delete a template with the given template ID. | key: deleteTemplate
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Template ID | The ID of the template. | 123456 |
{
"data": "Template deleted successfully."
}
Get Account
Retrieve a single account object by its account ID. | key: getAccount
| Input | Notes | Example |
|---|---|---|
| Account ID | The ID of the account to retrieve. | AbC123 |
| Connection | ||
| Fields | The fields to include in the response. |
{
"data": {
"data": {
"type": "account",
"id": "string",
"attributes": {
"testAccount": true,
"contactInformation": {
"defaultSenderName": "Klaviyo Demo",
"defaultSenderEmail": "contact@klaviyo-demo.com",
"websiteUrl": "https://www.klaviyo.com",
"organizationName": "Klaviyo Demo",
"streetAddress": {
"address1": "125 Summer Street",
"address2": "5th Floor",
"city": "Boston",
"region": "MA",
"country": "US",
"zip": "04323"
}
},
"industry": "Software / SaaS",
"timezone": "US/Eastern",
"preferredCurrency": "USD",
"publicApiKey": "AbC123",
"locale": "en-US"
},
"links": {
"self": "string"
}
}
}
}
Get Campaign
Returns a specific campaign based on a required id. | key: getCampaign
| Input | Notes | Example |
|---|---|---|
| Campaign ID | The ID of the campaign. | 01J2DNH88028WCAA2RK0BYBZVG |
| Connection | ||
| Fields | The fields to include in the response. |
{
"data": {
"data": {
"type": "campaign",
"id": "string",
"attributes": {
"name": "string",
"status": "string",
"archived": true,
"audiences": {
"included": [
"Y6nRLr"
],
"excluded": [
"UTd5ui"
]
},
"sendOptions": {
"useSmartSending": true
},
"trackingOptions": {
"isAddUtm": true,
"utmParams": [
{
"name": "utmMedium",
"value": "campaign"
}
],
"isTrackingClicks": true,
"isTrackingOpens": true
},
"sendStrategy": {
"method": "static",
"optionsStatic": {
"datetime": "2022-11-08T00:00:00.000Z",
"isLocal": true,
"sendPastRecipientsImmediately": true
},
"optionsThrottled": {
"datetime": "2024-07-14T01:37:30.052Z",
"throttlePercentage": 0
},
"optionsSto": {
"date": "2024-07-14"
}
},
"createdAt": "2022-11-08T00:00:00.000Z",
"scheduledAt": "2022-11-08T00:00:00.000Z",
"updatedAt": "2022-11-08T00:00:00.000Z",
"sendTime": "2022-11-08T00:00:00.000Z"
},
"links": {
"self": "string"
},
"relationships": {
"campaignMessages": {
"data": [
{
"type": "campaign-message",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
},
"tags": {
"data": [
{
"type": "tag",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
}
}
},
"included": [
{
"type": "campaign-message",
"id": "string",
"attributes": {
"label": "string",
"channel": "string",
"content": {
"subject": "Buy our product!",
"previewText": "My preview text",
"fromEmail": "store@my-company.com",
"fromLabel": "My Company",
"replyToEmail": "reply-to@my-company.com",
"ccEmail": "cc@my-company.com",
"bccEmail": "bcc@my-company.com"
},
"sendTimes": [
{
"datetime": "2022-11-08T00:00:00.000Z",
"isLocal": true
}
],
"renderOptions": {
"shortenLinks": true,
"addOrgPrefix": true,
"addInfoLink": true,
"addOptOutLanguage": false
},
"createdAt": "2022-11-08T00:00:00.000Z",
"updatedAt": "2022-11-08T00:00:00.000Z"
},
"links": {
"self": "string"
}
},
{
"type": "tag",
"id": "abcd1234-ef56-gh78-ij90-abcdef123456",
"attributes": {
"name": "My Tag"
},
"links": {
"self": "string"
}
}
]
}
}
Get Event
Get an event with the given event ID. | key: getEvent
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Event ID | The ID of the event. | 5nJKMJuHUQy |
| Event Fields | Event fields to include in the response. | |
| Metric Fields | Metric fields to include in the response. | |
| Profile Fields | Profile fields to include in the response. |
{
"data": {
"data": {
"type": "event",
"id": "string",
"attributes": {
"timestamp": 0,
"eventProperties": {},
"datetime": "2022-11-08T01:23:45.000Z",
"uuid": "string"
},
"links": {
"self": "string"
},
"relationships": {
"profile": {
"data": {
"type": "profile",
"id": "string"
},
"links": {
"self": "string",
"related": "string"
}
},
"metric": {
"data": {
"type": "metric",
"id": "string"
},
"links": {
"self": "string",
"related": "string"
}
},
"attributions": {
"data": [
{
"type": "attribution",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
}
}
},
"included": [
{
"type": "attribution",
"id": "925e385b52fb405715f3616c337cc65c",
"relationships": {
"event": {
"data": {
"type": "event",
"id": "string"
}
},
"attributedEvent": {
"data": {
"type": "event",
"id": "string"
}
},
"campaign": {
"data": {
"type": "campaign",
"id": "string"
}
},
"campaignMessage": {
"data": {
"type": "campaign-message",
"id": "string"
}
},
"flow": {
"data": {
"type": "flow",
"id": "string"
}
},
"flowMessage": {
"data": {
"type": "flow-message",
"id": "string"
}
},
"flowMessageVariation": {
"data": {
"type": "flow-message",
"id": "string"
}
}
},
"links": {
"self": "string"
}
},
{
"type": "metric",
"id": "string",
"attributes": {
"name": "string",
"created": "string",
"updated": "string",
"integration": {}
},
"links": {
"self": "string"
}
},
{
"type": "profile",
"id": "01GDDKASAP8TKDDA2GRZDSVP4H",
"attributes": {
"email": "sarah.mason@klaviyo-demo.com",
"phoneNumber": "+15005550006",
"externalId": "string",
"firstName": "Sarah",
"lastName": "Mason",
"organization": "Example Corporation",
"locale": "en-US",
"title": "Regional Manager",
"image": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"created": "2025-11-11T19:36:47.922Z",
"updated": "2025-11-11T19:36:47.922Z",
"lastEventDate": "2025-11-11T19:36:47.922Z",
"location": {
"address1": "89 E 42nd St",
"address2": "1st floor",
"city": "New York",
"country": "United States",
"latitude": "string",
"longitude": "string",
"region": "NY",
"zip": "10017",
"timezone": "America/New_York",
"ip": "127.0.0.1"
},
"properties": {
"pseudonym": "Dr. Octopus"
}
},
"links": {
"self": "string"
}
}
]
}
}
Get Image
Get the image with the given image ID. | key: getImage
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Fields | The fields to include in the response. | |
| Image ID | The ID of the image. | 155463624 |
{
"data": {
"data": {
"type": "image",
"id": "7",
"attributes": {
"name": "string",
"imageUrl": "string",
"format": "string",
"size": 0,
"hidden": true,
"updatedAt": "2022-11-08T00:00:00.000Z"
},
"links": {
"self": "string"
}
}
}
}
Get List
Get a list with the given list ID. | key: getList
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Fields | The fields to include in the response. | |
| List ID | The unique identifier of the list. | RE83th |
{
"data": {
"data": {
"type": "list",
"id": "Y6nRLr",
"attributes": {
"name": "Newsletter",
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z",
"optInProcess": "double_opt_in",
"profileCount": 0
},
"links": {
"self": "string"
},
"relationships": {
"profiles": {
"links": {
"self": "string",
"related": "string"
}
},
"tags": {
"data": [
{
"type": "tag",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
}
}
},
"included": [
{
"type": "tag",
"id": "abcd1234-ef56-gh78-ij90-abcdef123456",
"attributes": {
"name": "My Tag"
},
"links": {
"self": "string"
}
}
]
}
}
Get Profile
Get the profile with the given profile ID. | key: getProfile
| Input | Notes | Example |
|---|---|---|
| Additional Profile Fields | Request additional fields not included by default in the response. | |
| Connection | ||
| Fields | The fields to include in the response. | |
| Profile ID | Unique identifier for the profile. | 01J18FVB5H8XR1X9AXEQFVRW7A |
{
"data": {
"data": {
"type": "profile",
"id": "01GDDKASAP8TKDDA2GRZDSVP4H",
"attributes": {
"email": "sarah.mason@klaviyo-demo.com",
"phoneNumber": "+15005550006",
"externalId": "string",
"firstName": "Sarah",
"lastName": "Mason",
"organization": "Example Corporation",
"locale": "en-US",
"title": "Regional Manager",
"image": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z",
"lastEventDate": "2022-11-08T00:00:00.000Z",
"location": {
"address1": "89 E 42nd St",
"address2": "1st floor",
"city": "New York",
"country": "United States",
"latitude": "string",
"longitude": "string",
"region": "NY",
"zip": "10017",
"timezone": "America/New_York",
"ip": "127.0.0.1"
},
"properties": {
"pseudonym": "Dr. Octopus"
},
"subscriptions": {
"email": {
"marketing": {
"canReceiveEmailMarketing": true,
"consent": "SUBSCRIBED",
"consentTimestamp": "2023-02-21T20:07:38.000Z",
"lastUpdated": "2023-02-21T20:07:38.000Z",
"method": "PREFERENCE_PAGE",
"methodDetail": "mydomain.com/signup",
"customMethodDetail": "marketing drive",
"doubleOptin": true,
"suppression": [
{
"reason": "HARD_BOUNCE",
"timestamp": "2023-02-21T20:07:38.000Z"
}
],
"listSuppressions": [
{
"listId": "Y6nRLr",
"reason": "USER_SUPPRESSED",
"timestamp": "2023-02-21T20:07:38.000Z"
}
]
}
},
"sms": {
"marketing": {
"canReceiveSmsMarketing": true,
"consent": "SUBSCRIBED",
"consentTimestamp": "2023-02-21T20:07:38.000Z",
"method": "TEXT",
"methodDetail": "JOIN",
"lastUpdated": "2023-02-21T20:07:38.000Z"
}
}
},
"predictiveAnalytics": {
"historicClv": 93.87,
"predictedClv": 27.24,
"totalClv": 121.11,
"historicNumberOfOrders": 2,
"predictedNumberOfOrders": 0.54,
"averageDaysBetweenOrders": 189,
"averageOrderValue": 46.94,
"churnProbability": 0.89,
"expectedDateOfNextOrder": "2022-11-08T00:00:00.000Z"
}
},
"links": {
"self": "string"
},
"relationships": {
"lists": {
"data": [
{
"type": "list",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
},
"segments": {
"data": [
{
"type": "segment",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
}
}
},
"included": [
{
"type": "list",
"id": "Y6nRLr",
"attributes": {
"name": "Newsletter",
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z",
"optInProcess": "double_opt_in"
},
"links": {
"self": "string"
}
},
{
"type": "segment",
"id": "string",
"attributes": {
"name": "Repeat Purchasers",
"definition": {
"conditionGroups": [
{
"conditions": [
{
"type": "profile-group-membership",
"groupIds": [
"string"
],
"timeframeFilter": {
"type": "date",
"operator": "after",
"date": "2022-11-08T00:00:00.000Z"
},
"isMember": true
},
{
"type": "profile-metric",
"metricId": "string",
"measurement": "count",
"measurementFilter": {
"type": "numeric",
"operator": "equals",
"value": 0
},
"timeframeFilter": {
"type": "date",
"operator": "after",
"date": "2022-11-08T00:00:00.000Z"
},
"metricFilters": [
{
"property": "string",
"filter": {
"type": "string",
"operator": "equals",
"value": "string"
}
}
]
},
{
"type": "profile-marketing-consent",
"consent": {
"channel": "email",
"consentStatus": {
"subscription": "any"
},
"canReceiveMarketing": true
}
},
{
"type": "profile-postal-code-distance",
"countryCode": "string",
"postalCode": "string",
"unit": "kilometers",
"filter": {
"type": "numeric",
"operator": "greater-than",
"value": 0
}
},
{
"type": "profile-property",
"property": "string",
"filter": {
"type": "string",
"operator": "contains",
"value": "string"
}
},
{
"type": "profile-region",
"inRegion": true,
"region": "european_union"
},
{
"type": "profile-predictive-analytics",
"dimension": "average_days_between_orders",
"filter": {
"type": "numeric",
"operator": "equals",
"value": 0
}
},
{
"type": "profile-predictive-analytics",
"dimension": "predicted_gender",
"filter": {
"type": "string",
"operator": "equals",
"value": "likely_female"
}
}
]
}
]
},
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z",
"isActive": true,
"isProcessing": true,
"isStarred": true
},
"links": {
"self": "string"
}
}
]
}
}
Get Segment
Get a segment with the given segment ID. | key: getSegment
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Fields | The fields to include in the response. | |
| Segment ID | The ID of the segment. | WwKnkd |
{
"data": {
"data": {
"type": "segment",
"id": "string",
"attributes": {
"name": "Repeat Purchasers",
"definition": {
"conditionGroups": [
{
"conditions": [
{
"type": "profile-group-membership",
"groupIds": [
"string"
],
"timeframeFilter": {
"type": "date",
"operator": "after",
"date": "2022-11-08T00:00:00.000Z"
},
"isMember": true
},
{
"type": "profile-metric",
"metricId": "string",
"measurement": "count",
"measurementFilter": {
"type": "numeric",
"operator": "equals",
"value": 0
},
"timeframeFilter": {
"type": "date",
"operator": "after",
"date": "2022-11-08T00:00:00.000Z"
},
"metricFilters": [
{
"property": "string",
"filter": {
"type": "string",
"operator": "equals",
"value": "string"
}
}
]
},
{
"type": "profile-marketing-consent",
"consent": {
"channel": "email",
"consentStatus": {
"subscription": "any"
},
"canReceiveMarketing": true
}
},
{
"type": "profile-postal-code-distance",
"countryCode": "string",
"postalCode": "string",
"unit": "kilometers",
"filter": {
"type": "numeric",
"operator": "greater-than",
"value": 0
}
},
{
"type": "profile-property",
"property": "string",
"filter": {
"type": "string",
"operator": "contains",
"value": "string"
}
},
{
"type": "profile-region",
"inRegion": true,
"region": "european_union"
},
{
"type": "profile-predictive-analytics",
"dimension": "average_days_between_orders",
"filter": {
"type": "numeric",
"operator": "equals",
"value": 0
}
},
{
"type": "profile-predictive-analytics",
"dimension": "predicted_gender",
"filter": {
"type": "string",
"operator": "equals",
"value": "likely_female"
}
}
]
}
]
},
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z",
"isActive": true,
"isProcessing": true,
"isStarred": true,
"profileCount": 0
},
"links": {
"self": "string"
},
"relationships": {
"profiles": {
"links": {
"self": "string",
"related": "string"
}
},
"tags": {
"data": [
{
"type": "tag",
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
}
],
"links": {
"self": "string",
"related": "string"
}
}
}
},
"included": [
{
"type": "tag",
"id": "abcd1234-ef56-gh78-ij90-abcdef123456",
"attributes": {
"name": "My Tag"
},
"links": {
"self": "string"
}
}
]
}
}
Get Template
Get a template with the given template ID. | key: getTemplate
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Fields | The fields to include in the response. | |
| Template ID | The ID of the template. | 123456 |
{
"data": {
"data": {
"type": "template",
"id": "string",
"attributes": {
"name": "string",
"editorType": "string",
"html": "string",
"text": "string",
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z"
},
"links": {
"self": "string"
}
}
}
}
List Accounts
Retrieve the account(s) associated with a given private API key. | key: listAccounts
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Fields | The fields to include in the response. |
{
"data": {
"data": [
{
"type": "account",
"id": "string",
"attributes": {
"testAccount": true,
"contactInformation": {
"defaultSenderName": "Klaviyo Demo",
"defaultSenderEmail": "contact@klaviyo-demo.com",
"websiteUrl": "https://www.klaviyo.com",
"organizationName": "Klaviyo Demo",
"streetAddress": {
"address1": "125 Summer Street",
"address2": "5th Floor",
"city": "Boston",
"region": "MA",
"country": "US",
"zip": "04323"
}
},
"industry": "Software / SaaS",
"timezone": "US/Eastern",
"preferredCurrency": "USD",
"publicApiKey": "AbC123",
"locale": "en-US"
},
"links": {
"self": "string"
}
}
],
"links": {
"self": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
List Campaigns
Returns some or all campaigns based on filters. | key: listCampaigns
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Fields | The fields to include in the response. | |
| Filter Campaigns | A filter to apply to the campaigns. | equals(messages.channel,'sms') |
{
"data": {
"data": [
{
"type": "campaign",
"id": "string",
"attributes": {
"name": "string",
"status": "string",
"archived": true,
"audiences": {
"included": [
"Y6nRLr"
],
"excluded": [
"UTd5ui"
]
},
"sendOptions": {
"useSmartSending": true
},
"trackingOptions": {
"isAddUtm": true,
"utmParams": [
{
"name": "utmMedium",
"value": "campaign"
}
],
"isTrackingClicks": true,
"isTrackingOpens": true
},
"sendStrategy": {
"method": "static",
"optionsStatic": {
"datetime": "2022-11-08T00:00:00.000Z",
"isLocal": true,
"sendPastRecipientsImmediately": true
},
"optionsThrottled": {
"datetime": "2024-07-14T01:37:30.052Z",
"throttlePercentage": 0
},
"optionsSto": {
"date": "2024-07-14"
}
},
"createdAt": "2022-11-08T00:00:00.000Z",
"scheduledAt": "2022-11-08T00:00:00.000Z",
"updatedAt": "2022-11-08T00:00:00.000Z",
"sendTime": "2022-11-08T00:00:00.000Z"
},
"links": {
"self": "string"
},
"relationships": {
"campaignMessages": {
"data": [
{
"type": "campaign-message",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
},
"tags": {
"data": [
{
"type": "tag",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
}
}
}
],
"links": {
"self": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"included": [
{
"type": "campaign-message",
"id": "string",
"attributes": {
"label": "string",
"channel": "string",
"content": {
"subject": "Buy our product!",
"previewText": "My preview text",
"fromEmail": "store@my-company.com",
"fromLabel": "My Company",
"replyToEmail": "reply-to@my-company.com",
"ccEmail": "cc@my-company.com",
"bccEmail": "bcc@my-company.com"
},
"sendTimes": [
{
"datetime": "2022-11-08T00:00:00.000Z",
"isLocal": true
}
],
"renderOptions": {
"shortenLinks": true,
"addOrgPrefix": true,
"addInfoLink": true,
"addOptOutLanguage": false
},
"createdAt": "2022-11-08T00:00:00.000Z",
"updatedAt": "2022-11-08T00:00:00.000Z"
},
"links": {
"self": "string"
}
},
{
"type": "tag",
"id": "abcd1234-ef56-gh78-ij90-abcdef123456",
"attributes": {
"name": "My Tag"
},
"links": {
"self": "string"
}
}
]
}
}
List Events
Get all events in an account. | key: listEvents
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Event Fields | Event fields to include in the response. | |
| Metric Fields | Metric fields to include in the response. | |
| Profile Fields | Profile fields to include in the response. |
{
"data": {
"data": [
{
"type": "event",
"id": "string",
"attributes": {
"timestamp": 0,
"eventProperties": {},
"datetime": "2022-11-08T01:23:45.000Z",
"uuid": "string"
},
"links": {
"self": "string"
},
"relationships": {
"profile": {
"data": {
"type": "profile",
"id": "string"
},
"links": {
"self": "string",
"related": "string"
}
},
"metric": {
"data": {
"type": "metric",
"id": "string"
},
"links": {
"self": "string",
"related": "string"
}
},
"attributions": {
"data": [
{
"type": "attribution",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
}
}
}
],
"links": {
"self": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"included": [
{
"type": "attribution",
"id": "925e385b52fb405715f3616c337cc65c",
"relationships": {
"event": {
"data": {
"type": "event",
"id": "string"
}
},
"attributedEvent": {
"data": {
"type": "event",
"id": "string"
}
},
"campaign": {
"data": {
"type": "campaign",
"id": "string"
}
},
"campaignMessage": {
"data": {
"type": "campaign-message",
"id": "string"
}
},
"flow": {
"data": {
"type": "flow",
"id": "string"
}
},
"flowMessage": {
"data": {
"type": "flow-message",
"id": "string"
}
},
"flowMessageVariation": {
"data": {
"type": "flow-message",
"id": "string"
}
}
},
"links": {
"self": "string"
}
},
{
"type": "metric",
"id": "string",
"attributes": {
"name": "string",
"created": "string",
"updated": "string",
"integration": {}
},
"links": {
"self": "string"
}
},
{
"type": "profile",
"id": "01GDDKASAP8TKDDA2GRZDSVP4H",
"attributes": {
"email": "sarah.mason@klaviyo-demo.com",
"phoneNumber": "+15005550006",
"externalId": "string",
"firstName": "Sarah",
"lastName": "Mason",
"organization": "Example Corporation",
"locale": "en-US",
"title": "Regional Manager",
"image": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"created": "2025-11-11T19:36:47.922Z",
"updated": "2025-11-11T19:36:47.922Z",
"lastEventDate": "2025-11-11T19:36:47.922Z",
"location": {
"address1": "89 E 42nd St",
"address2": "1st floor",
"city": "New York",
"country": "United States",
"latitude": "string",
"longitude": "string",
"region": "NY",
"zip": "10017",
"timezone": "America/New_York",
"ip": "127.0.0.1"
},
"properties": {
"pseudonym": "Dr. Octopus"
}
},
"links": {
"self": "string"
}
}
]
}
}
List Images
Get all images in an account. | key: listImages
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Fields | The fields to include in the response. |
{
"data": {
"data": [
{
"type": "image",
"id": "7",
"attributes": {
"name": "string",
"imageUrl": "string",
"format": "string",
"size": 0,
"hidden": true,
"updatedAt": "2022-11-08T00:00:00.000Z"
},
"links": {
"self": "string"
}
}
],
"links": {
"self": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
List List Profiles
Get all profiles within a list with the given list ID. | key: listListProfiles
| Input | Notes | Example |
|---|---|---|
| Additional Profile Fields | Request additional fields not included by default in the response. | |
| Connection | ||
| Fields | The fields to include in the response. | |
| List ID | The unique identifier of the list. | RE83th |
{
"data": {
"data": [
{
"type": "profile",
"id": "01GDDKASAP8TKDDA2GRZDSVP4H",
"attributes": {
"email": "sarah.mason@klaviyo-demo.com",
"phoneNumber": "+15005550006",
"externalId": "string",
"firstName": "Sarah",
"lastName": "Mason",
"organization": "Example Corporation",
"locale": "en-US",
"title": "Regional Manager",
"image": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z",
"lastEventDate": "2022-11-08T00:00:00.000Z",
"location": {
"address1": "89 E 42nd St",
"address2": "1st floor",
"city": "New York",
"country": "United States",
"latitude": "string",
"longitude": "string",
"region": "NY",
"zip": "10017",
"timezone": "America/New_York",
"ip": "127.0.0.1"
},
"properties": {
"pseudonym": "Dr. Octopus"
},
"joinedGroupAt": "2022-11-08T00:00:00.000Z",
"subscriptions": {
"email": {
"marketing": {
"canReceiveEmailMarketing": true,
"consent": "SUBSCRIBED",
"consentTimestamp": "2023-02-21T20:07:38.000Z",
"lastUpdated": "2023-02-21T20:07:38.000Z",
"method": "PREFERENCE_PAGE",
"methodDetail": "mydomain.com/signup",
"customMethodDetail": "marketing drive",
"doubleOptin": true,
"suppression": [
{
"reason": "HARD_BOUNCE",
"timestamp": "2023-02-21T20:07:38.000Z"
}
],
"listSuppressions": [
{
"listId": "Y6nRLr",
"reason": "USER_SUPPRESSED",
"timestamp": "2023-02-21T20:07:38.000Z"
}
]
}
},
"sms": {
"marketing": {
"canReceiveSmsMarketing": true,
"consent": "SUBSCRIBED",
"consentTimestamp": "2023-02-21T20:07:38.000Z",
"method": "TEXT",
"methodDetail": "JOIN",
"lastUpdated": "2023-02-21T20:07:38.000Z"
}
}
},
"predictiveAnalytics": {
"historicClv": 93.87,
"predictedClv": 27.24,
"totalClv": 121.11,
"historicNumberOfOrders": 2,
"predictedNumberOfOrders": 0.54,
"averageDaysBetweenOrders": 189,
"averageOrderValue": 46.94,
"churnProbability": 0.89,
"expectedDateOfNextOrder": "2022-11-08T00:00:00.000Z"
}
},
"links": {
"self": "string"
},
"relationships": {
"lists": {
"links": {
"self": "string",
"related": "string"
}
},
"segments": {
"links": {
"self": "string",
"related": "string"
}
}
}
}
],
"links": {
"self": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
List Lists
Get all lists in an account. | key: listLists
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Fields | The fields to include in the response. |
{
"data": {
"data": [
{
"type": "list",
"id": "Y6nRLr",
"attributes": {
"name": "Newsletter",
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z",
"optInProcess": "double_opt_in"
},
"links": {
"self": "string"
},
"relationships": {
"profiles": {
"links": {
"self": "string",
"related": "string"
}
},
"tags": {
"data": [
{
"type": "tag",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
}
}
}
],
"links": {
"self": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"included": [
{
"type": "tag",
"id": "abcd1234-ef56-gh78-ij90-abcdef123456",
"attributes": {
"name": "My Tag"
},
"links": {
"self": "string"
}
}
]
}
}
List Profile
Get all profiles in an account. | key: listProfile
| Input | Notes | Example |
|---|---|---|
| Additional Profile Fields | Request additional fields not included by default in the response. | |
| Connection | ||
| Fields | The fields to include in the response. |
{
"data": {
"data": [
{
"type": "profile",
"id": "01GDDKASAP8TKDDA2GRZDSVP4H",
"attributes": {
"email": "sarah.mason@klaviyo-demo.com",
"phoneNumber": "+15005550006",
"externalId": "string",
"firstName": "Sarah",
"lastName": "Mason",
"organization": "Example Corporation",
"locale": "en-US",
"title": "Regional Manager",
"image": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z",
"lastEventDate": "2022-11-08T00:00:00.000Z",
"location": {
"address1": "89 E 42nd St",
"address2": "1st floor",
"city": "New York",
"country": "United States",
"latitude": "string",
"longitude": "string",
"region": "NY",
"zip": "10017",
"timezone": "America/New_York",
"ip": "127.0.0.1"
},
"properties": {
"pseudonym": "Dr. Octopus"
},
"subscriptions": {
"email": {
"marketing": {
"canReceiveEmailMarketing": true,
"consent": "SUBSCRIBED",
"consentTimestamp": "2023-02-21T20:07:38.000Z",
"lastUpdated": "2023-02-21T20:07:38.000Z",
"method": "PREFERENCE_PAGE",
"methodDetail": "mydomain.com/signup",
"customMethodDetail": "marketing drive",
"doubleOptin": true,
"suppression": [
{
"reason": "HARD_BOUNCE",
"timestamp": "2023-02-21T20:07:38.000Z"
}
],
"listSuppressions": [
{
"listId": "Y6nRLr",
"reason": "USER_SUPPRESSED",
"timestamp": "2023-02-21T20:07:38.000Z"
}
]
}
},
"sms": {
"marketing": {
"canReceiveSmsMarketing": true,
"consent": "SUBSCRIBED",
"consentTimestamp": "2023-02-21T20:07:38.000Z",
"method": "TEXT",
"methodDetail": "JOIN",
"lastUpdated": "2023-02-21T20:07:38.000Z"
}
}
},
"predictiveAnalytics": {
"historicClv": 93.87,
"predictedClv": 27.24,
"totalClv": 121.11,
"historicNumberOfOrders": 2,
"predictedNumberOfOrders": 0.54,
"averageDaysBetweenOrders": 189,
"averageOrderValue": 46.94,
"churnProbability": 0.89,
"expectedDateOfNextOrder": "2022-11-08T00:00:00.000Z"
}
},
"links": {
"self": "string"
},
"relationships": {
"lists": {
"links": {
"self": "string",
"related": "string"
}
},
"segments": {
"links": {
"self": "string",
"related": "string"
}
}
}
}
],
"links": {
"self": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
List Segments
Get all segments in an account. | key: listSegments
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Fields | The fields to include in the response. |
{
"data": {
"data": [
{
"type": "segment",
"id": "string",
"attributes": {
"name": "Repeat Purchasers",
"definition": {
"conditionGroups": [
{
"conditions": [
{
"type": "profile-group-membership",
"groupIds": [
"string"
],
"timeframeFilter": {
"type": "date",
"operator": "after",
"date": "2022-11-08T00:00:00.000Z"
},
"isMember": true
},
{
"type": "profile-metric",
"metricId": "string",
"measurement": "count",
"measurementFilter": {
"type": "numeric",
"operator": "equals",
"value": 0
},
"timeframeFilter": {
"type": "date",
"operator": "after",
"date": "2022-11-08T00:00:00.000Z"
},
"metricFilters": [
{
"property": "string",
"filter": {
"type": "string",
"operator": "equals",
"value": "string"
}
}
]
},
{
"type": "profile-marketing-consent",
"consent": {
"channel": "email",
"consentStatus": {
"subscription": "any"
},
"canReceiveMarketing": true
}
},
{
"type": "profile-postal-code-distance",
"countryCode": "string",
"postalCode": "string",
"unit": "kilometers",
"filter": {
"type": "numeric",
"operator": "greater-than",
"value": 0
}
},
{
"type": "profile-property",
"property": "string",
"filter": {
"type": "string",
"operator": "contains",
"value": "string"
}
},
{
"type": "profile-region",
"inRegion": true,
"region": "european_union"
},
{
"type": "profile-predictive-analytics",
"dimension": "average_days_between_orders",
"filter": {
"type": "numeric",
"operator": "equals",
"value": 0
}
},
{
"type": "profile-predictive-analytics",
"dimension": "predicted_gender",
"filter": {
"type": "string",
"operator": "equals",
"value": "likely_female"
}
}
]
}
]
},
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z",
"isActive": true,
"isProcessing": true,
"isStarred": true
},
"links": {
"self": "string"
},
"relationships": {
"profiles": {
"links": {
"self": "string",
"related": "string"
}
},
"tags": {
"data": [
{
"type": "tag",
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
}
],
"links": {
"self": "string",
"related": "string"
}
}
}
}
],
"links": {
"self": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"included": [
{
"type": "tag",
"id": "abcd1234-ef56-gh78-ij90-abcdef123456",
"attributes": {
"name": "My Tag"
},
"links": {
"self": "string"
}
}
]
}
}
List Templates
Get all templates in an account. | key: listTemplates
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Fields | The fields to include in the response. |
{
"data": {
"data": [
{
"type": "template",
"id": "string",
"attributes": {
"name": "string",
"editorType": "string",
"html": "string",
"text": "string",
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z"
},
"links": {
"self": "string"
}
}
],
"links": {
"self": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
Raw Request
Send raw HTTP request to Klaviyo. | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| Exclude Authorization | Exclude the Authorization header from the request. Turn this on and include the company_id query param when calling public endpoints (/client). | false |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Method | The HTTP method to use. | |
| Query Parameter | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | Input the path only (/api/accounts), The base URL is already included (https://a.klaviyo.com). For example, to connect to https://a.klaviyo.com/api/accounts, only /api/accounts is entered in this field. | /api/accounts |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
Subscribe Profiles
Subscribe one or more profiles to email marketing, SMS marketing, or both. | key: subscribeProfiles
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Profiles | Array of profiles to subscribe. |
{
"data": "Profiles subscribed successfully."
}
Unsubscribe Profiles
Unsubscribe one or more profiles to email marketing, SMS marketing, or both. | key: unsubscribeProfiles
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Profiles | Array of profiles to unsubscribe. |
{
"data": "Profiles unsubscribed successfully."
}
Update Campaign
Update a campaign with the given campaign ID. | key: updateCampaign
| Input | Notes | Example |
|---|---|---|
| Campaign ID | The ID of the campaign. | 01J2DNH88028WCAA2RK0BYBZVG |
| Campaign Name | The name of the campaign. | My new campaign |
| Connection | ||
| Excluded Audiences | A list of excluded audiences. | X7MYfE |
| Included Audiences | A list of included audiences. | X7MYfE |
| Send Options | The send options for the campaign. | |
| Send Strategy | The send strategy for the campaign. | |
| Tracking Options | The tracking options for the campaign. |
{
"data": {
"data": {
"type": "campaign",
"id": "string",
"attributes": {
"name": "string",
"status": "string",
"archived": true,
"audiences": {
"included": [
"Y6nRLr"
],
"excluded": [
"UTd5ui"
]
},
"sendOptions": {
"useSmartSending": true
},
"trackingOptions": {
"isAddUtm": true,
"utmParams": [
{
"name": "utmMedium",
"value": "campaign"
}
],
"isTrackingClicks": true,
"isTrackingOpens": true
},
"sendStrategy": {
"method": "static",
"optionsStatic": {
"datetime": "2022-11-08T00:00:00.000Z",
"isLocal": true,
"sendPastRecipientsImmediately": true
},
"optionsThrottled": {
"datetime": "2024-07-14T01:37:30.052Z",
"throttlePercentage": 0
},
"optionsSto": {
"date": "2024-07-14"
}
},
"createdAt": "2022-11-08T00:00:00.000Z",
"scheduledAt": "2022-11-08T00:00:00.000Z",
"updatedAt": "2022-11-08T00:00:00.000Z",
"sendTime": "2022-11-08T00:00:00.000Z"
},
"relationships": {
"campaignMessages": {
"data": [
{
"type": "campaign-message",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
},
"tags": {
"data": [
{
"type": "tag",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
}
},
"links": {
"self": "string"
}
}
}
}
Update Image
Update the image with the given image ID. | key: updateImage
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Image Hidden | ||
| Image ID | The ID of the image. | 155463624 |
| Image Name | A name for the image. Defaults to the filename if not provided. If the name matches an existing image, a suffix will be added. | My Image |
{
"data": {
"data": {
"type": "image",
"id": "7",
"attributes": {
"name": "string",
"imageUrl": "string",
"format": "string",
"size": 0,
"hidden": true,
"updatedAt": "2022-11-08T00:00:00.000Z"
},
"links": {
"self": "string"
}
}
}
}
Update List
Update the name of a list with the given list ID. | key: updateList
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| List ID | The unique identifier of the list. | RE83th |
| List Name | A helpful name to label the list. | Newsletter |
{
"data": {
"data": {
"type": "list",
"id": "Y6nRLr",
"attributes": {
"name": "Newsletter",
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z",
"optInProcess": "double_opt_in"
},
"relationships": {
"profiles": {
"data": [
{
"type": "profile",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
},
"tags": {
"data": [
{
"type": "tag",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
}
},
"links": {
"self": "string"
}
}
}
}
Update Profile
Update the profile with the given profile ID. | key: updateProfile
| Input | Notes | Example |
|---|---|---|
| Connection | ||
Individual's email address | sarah.mason@klaviyo-demo.com | |
| 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. Format varies based on the external system. | 12345 |
| First Name | Individual's first name | Sarah |
| Image | URL pointing to the location of a profile image | https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg |
| Last Name | Individual's last name | Mason |
| Location | Location information for the profile. | |
| Organization | Name of the company or organization within the company for whom the individual works | Example Corporation |
| Phone Number | Individual's phone number in E.164 format | +15005550006 |
| Profile ID | Unique identifier for the profile. | 01J18FVB5H8XR1X9AXEQFVRW7A |
| Properties | An object containing key/value pairs for any custom properties assigned to this profile. | |
| Title | Individual's job title | Regional Manager |
{
"data": {
"data": {
"type": "profile",
"id": "01GDDKASAP8TKDDA2GRZDSVP4H",
"attributes": {
"email": "sarah.mason@klaviyo-demo.com",
"phoneNumber": "+15005550006",
"externalId": "string",
"firstName": "Sarah",
"lastName": "Mason",
"organization": "Example Corporation",
"locale": "en-US",
"title": "Regional Manager",
"image": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z",
"lastEventDate": "2022-11-08T00:00:00.000Z",
"location": {
"address1": "89 E 42nd St",
"address2": "1st floor",
"city": "New York",
"country": "United States",
"latitude": "string",
"longitude": "string",
"region": "NY",
"zip": "10017",
"timezone": "America/New_York",
"ip": "127.0.0.1"
},
"properties": {
"pseudonym": "Dr. Octopus"
},
"subscriptions": {
"email": {
"marketing": {
"canReceiveEmailMarketing": true,
"consent": "SUBSCRIBED",
"consentTimestamp": "2023-02-21T20:07:38.000Z",
"lastUpdated": "2023-02-21T20:07:38.000Z",
"method": "PREFERENCE_PAGE",
"methodDetail": "mydomain.com/signup",
"customMethodDetail": "marketing drive",
"doubleOptin": true,
"suppression": [
{
"reason": "HARD_BOUNCE",
"timestamp": "2023-02-21T20:07:38.000Z"
}
],
"listSuppressions": [
{
"listId": "Y6nRLr",
"reason": "USER_SUPPRESSED",
"timestamp": "2023-02-21T20:07:38.000Z"
}
]
}
},
"sms": {
"marketing": {
"canReceiveSmsMarketing": true,
"consent": "SUBSCRIBED",
"consentTimestamp": "2023-02-21T20:07:38.000Z",
"method": "TEXT",
"methodDetail": "JOIN",
"lastUpdated": "2023-02-21T20:07:38.000Z"
}
}
},
"predictiveAnalytics": {
"historicClv": 93.87,
"predictedClv": 27.24,
"totalClv": 121.11,
"historicNumberOfOrders": 2,
"predictedNumberOfOrders": 0.54,
"averageDaysBetweenOrders": 189,
"averageOrderValue": 46.94,
"churnProbability": 0.89,
"expectedDateOfNextOrder": "2022-11-08T00:00:00.000Z"
}
},
"relationships": {
"lists": {
"data": [
{
"type": "list",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
},
"segments": {
"data": [
{
"type": "segment",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
}
},
"links": {
"self": "string"
}
}
}
}
Update Segment
Update a segment with the given segment ID. | key: updateSegment
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Is Starred Segment | Whether the segment is starred. | |
| Segment Condition Groups | The condition groups that define the segment. | |
| Segment ID | The ID of the segment. | WwKnkd |
| Segment Name | The name of the segment. | A segment |
{
"data": {
"data": {
"type": "segment",
"id": "string",
"attributes": {
"name": "Repeat Purchasers",
"definition": {
"conditionGroups": [
{
"conditions": [
{
"type": "profile-group-membership",
"groupIds": [
"string"
],
"timeframeFilter": {
"type": "date",
"operator": "after",
"date": "2022-11-08T00:00:00.000Z"
},
"isMember": true
},
{
"type": "profile-metric",
"metricId": "string",
"measurement": "count",
"measurementFilter": {
"type": "numeric",
"operator": "equals",
"value": 0
},
"timeframeFilter": {
"type": "date",
"operator": "after",
"date": "2022-11-08T00:00:00.000Z"
},
"metricFilters": [
{
"property": "string",
"filter": {
"type": "string",
"operator": "equals",
"value": "string"
}
}
]
},
{
"type": "profile-marketing-consent",
"consent": {
"channel": "email",
"consentStatus": {
"subscription": "any"
},
"canReceiveMarketing": true
}
},
{
"type": "profile-postal-code-distance",
"countryCode": "string",
"postalCode": "string",
"unit": "kilometers",
"filter": {
"type": "numeric",
"operator": "greater-than",
"value": 0
}
},
{
"type": "profile-property",
"property": "string",
"filter": {
"type": "string",
"operator": "contains",
"value": "string"
}
},
{
"type": "profile-region",
"inRegion": true,
"region": "european_union"
},
{
"type": "profile-predictive-analytics",
"dimension": "average_days_between_orders",
"filter": {
"type": "numeric",
"operator": "equals",
"value": 0
}
},
{
"type": "profile-predictive-analytics",
"dimension": "predicted_gender",
"filter": {
"type": "string",
"operator": "equals",
"value": "likely_female"
}
}
]
}
]
},
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z",
"isActive": true,
"isProcessing": true,
"isStarred": true
},
"relationships": {
"profiles": {
"data": [
{
"type": "profile",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
},
"tags": {
"data": [
{
"type": "tag",
"id": "string"
}
],
"links": {
"self": "string",
"related": "string"
}
}
},
"links": {
"self": "string"
}
}
}
}
Update Template
Update a template with the given template ID. | key: updateTemplate
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Template HTML | The HTML content of the template. | <html><body><p>Hello, world!</p></body></html> |
| Template ID | The ID of the template. | 123456 |
| Template Name | The name of the template. | Monthly Newsletter Template |
| Template Text | The text content of the template. | Hello, world! |
{
"data": {
"data": {
"type": "template",
"id": "string",
"attributes": {
"name": "string",
"editorType": "string",
"html": "string",
"text": "string",
"created": "2022-11-08T00:00:00.000Z",
"updated": "2022-11-08T00:00:00.000Z"
},
"links": {
"self": "string"
}
}
}
}
Upload Image
Import an image from a url or file. | key: uploadImage
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| File Data | The contents to write to a file. Binary data generated from a previous step. | |
| Image Name | A name for the image. Defaults to the filename if not provided. If the name matches an existing image, a suffix will be added. | My Image |
| Image URL | An existing image url to import the image from. Alternatively, you may specify a base-64 encoded data-uri ( | https://example.com/image.jpg |
{
"data": {
"data": {
"type": "image",
"id": "7",
"attributes": {
"name": "string",
"imageUrl": "string",
"format": "string",
"size": 0,
"hidden": true,
"updatedAt": "2022-11-08T00:00:00.000Z"
},
"links": {
"self": "string"
}
}
}
}
Changelog
2025-07-23
Added inline data sources for accounts, campaigns, events, profiles, and templates to enhance data selection capabilities