Skip to main content

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 ·
· Changelog ↓

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​

key: klaviyoApiKeyConnection

Authentication via API key is now deprecated. Please use OAuth 2.0 for authentication instead. See Klaviyo documentation.

InputNotesExample
API Key

Your API Key for Klaviyo

OAuth 2.0​

key: klaviyoOAuth2Connection

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:

  1. Log into your Klaviyo account and navigate to the Manage apps page.
  2. Select Create App
  3. Name the app and copy your Client ID and Client Secret and enter them into the connection configuration of your integration
  4. Save and continue to proceed
  5. Once creation has been completed enter the the following into the Redirect URL field: https://oauth2.prismatic.io/callback and save.
  6. Select Review Submission to submit the app for completion.
InputNotesExample
Authorize URLhttps://www.klaviyo.com/oauth/authorize
Client ID
Client secret
Scopes

Space separated list of scopes if needed

Token URLhttps://a.klaviyo.com/oauth/token

Triggers​

New and Updated Campaigns​

Checks for new and updated campaigns in Klaviyo on a configured schedule. | key: pollCampaignChangesTrigger

InputNotesExample
Connection
Message Channel

Klaviyo requires a channel filter to list campaigns. Select which channel's campaigns the trigger should return.

Show New Records

When true, newly created records are included in the trigger output.

true
Show Updated Records

When true, records updated since the last poll are included in the trigger output.

true

This trigger polls the Klaviyo API for new and updated campaigns on the selected message channel since the last execution.

How It Works​

  1. The trigger runs on the configured polling schedule
  2. On the first execution, the current timestamp is stored as the initial lastPolledAt state and no records are returned
  3. On each subsequent execution, a server-side Klaviyo JSON:API filter is built from the configured Message Channel and the stored lastPolledAt: and(equals(messages.channel,'<channel>'),greater-than(updated_at,<lastPolledAt>))
  4. All paginated campaign records matching the filter are fetched via the Klaviyo Campaigns API
  5. Returned records are categorized client-side as created or updated based on the created_at timestamp relative to lastPolledAt — records whose created_at exceeds lastPolledAt are classified as created; all other records returned by the filter are classified as updated
  6. After the fetch completes, the current timestamp is stored as the new lastPolledAt
  7. If both Show New Records and Show Updated Records are disabled, the trigger short-circuits without calling the API and still advances lastPolledAt

The trigger sets polledNoChanges: true when no matching records are returned, allowing downstream flows to skip execution when there is nothing to process.

Configuration​

Configure the following inputs:

  • Connection: The Klaviyo connection used to authenticate API requests
  • Message Channel: The Klaviyo message channel to filter campaigns by — Email, SMS, or Mobile Push. Klaviyo requires this filter on every campaign list call
  • Show New Records: When enabled, includes newly created campaigns in the results. Defaults to true
  • Show Updated Records: When enabled, includes modified campaigns in the results. Defaults to true

Returned Data​

The trigger returns an object with two arrays — created for newly created campaigns and updated for modified campaigns. Both arrays follow the Klaviyo JSON:API resource shape.

Example Payload
{
  "data": {
    "created": [
      {
        "type": "campaign",
        "id": "01HABCDEF0123456789CAMPAIGN1",
        "attributes": {
          "name": "Spring Sale Email",
          "status": "Draft",
          "archived": false,
          "audiences": {
            "included": ["Y6nRLr"],
            "excluded": []
          },
          "send_options": {
            "use_smart_sending": true
          },
          "tracking_options": {
            "is_tracking_clicks": true,
            "is_tracking_opens": true
          },
          "send_strategy": {
            "method": "static"
          },
          "created_at": "2026-04-15T14:30:00Z",
          "scheduled_at": null,
          "updated_at": "2026-04-15T14:30:00Z",
          "send_time": null
        },
        "relationships": {
          "campaign-messages": {
            "data": [{ "type": "campaign-message", "id": "01HMSG0123456789" }]
          }
        }
      }
    ],
    "updated": [
      {
        "type": "campaign",
        "id": "01HABCDEF0123456789CAMPAIGN2",
        "attributes": {
          "name": "Welcome Series",
          "status": "Sent",
          "archived": false,
          "audiences": {
            "included": ["UTd5ui"],
            "excluded": []
          },
          "created_at": "2026-03-01T09:00:00Z",
          "scheduled_at": "2026-03-02T15:00:00Z",
          "updated_at": "2026-04-15T16:22:00Z",
          "send_time": "2026-03-02T15:00:00Z"
        }
      }
    ]
  }
}

Notes​

  • The messages.channel equality filter is required by the Klaviyo Campaigns API — campaign list calls without it are rejected
  • The greater-than(updated_at,...) clause is applied server-side, so only campaigns modified since the last poll are returned
  • A newly created campaign has created_at == updated_at, so the same record is never classified as both created and updated
  • Refer to the Klaviyo API rate limits documentation for throttling behavior and the Get Campaigns endpoint reference for the full list of returned attributes

New and Updated Profiles and Lists​

Checks for new and updated profiles and lists in Klaviyo on a configured schedule. | key: pollProfileAndListChangesTrigger

InputNotesExample
Connection
Resource Type

The type of resource to poll for new and updated records.

Show New Records

When true, newly created records are included in the trigger output.

true
Show Updated Records

When true, records updated since the last poll are included in the trigger output.

true

This trigger polls the Klaviyo API for new and updated profiles or lists since the last execution.

How It Works​

  1. The trigger runs on the configured polling schedule
  2. On the first execution, the current timestamp is stored as the initial lastPolledAt state and no records are returned
  3. On each subsequent execution, a server-side Klaviyo JSON:API filter is built from the stored lastPolledAt: greater-than(updated,<lastPolledAt>)
  4. All paginated records of the selected Resource Type matching the filter are fetched via the corresponding Klaviyo API (Profiles or Lists)
  5. Returned records are categorized client-side as created or updated based on the created timestamp relative to lastPolledAt — records whose created exceeds lastPolledAt are classified as created; all other records returned by the filter are classified as updated
  6. After the fetch completes, the current timestamp is stored as the new lastPolledAt
  7. If both Show New Records and Show Updated Records are disabled, the trigger short-circuits without calling the API and still advances lastPolledAt

The trigger sets polledNoChanges: true when no matching records are returned, allowing downstream flows to skip execution when there is nothing to process.

Configuration​

Configure the following inputs:

  • Connection: The Klaviyo connection used to authenticate API requests
  • Resource Type: The Klaviyo resource to poll — Profiles or Lists
  • Show New Records: When enabled, includes newly created records in the results. Defaults to true
  • Show Updated Records: When enabled, includes modified records in the results. Defaults to true

Supported Resource Types​

Resource TypeKlaviyo EndpointCreated FieldUpdated Field
profilesGET /api/profilescreatedupdated
listsGET /api/listscreatedupdated

Returned Data​

The trigger returns an object with two arrays — created for newly created records and updated for modified records. Each record follows the Klaviyo JSON:API resource shape for the selected resource type.

Example Payload (Profiles)
{
  "data": {
    "created": [
      {
        "type": "profile",
        "id": "01HPROFILE0123456789ABCDEF",
        "attributes": {
          "email": "jane.doe@example.com",
          "phone_number": "+15555550123",
          "first_name": "Jane",
          "last_name": "Doe",
          "created": "2026-04-15T14:30:00Z",
          "updated": "2026-04-15T14:30:00Z",
          "last_event_date": null,
          "subscriptions": {
            "email": {
              "marketing": {
                "can_receive_email_marketing": true,
                "consent": "SUBSCRIBED"
              }
            }
          }
        }
      }
    ],
    "updated": [
      {
        "type": "profile",
        "id": "01HPROFILE9876543210ZYXWVU",
        "attributes": {
          "email": "john.smith@example.com",
          "first_name": "John",
          "last_name": "Smith",
          "created": "2025-12-01T09:00:00Z",
          "updated": "2026-04-15T16:22:00Z",
          "last_event_date": "2026-04-15T16:22:00Z"
        }
      }
    ]
  }
}
Example Payload (Lists)
{
  "data": {
    "created": [
      {
        "type": "list",
        "id": "Y6nRLr",
        "attributes": {
          "name": "Spring Newsletter",
          "created": "2026-04-15T14:30:00Z",
          "updated": "2026-04-15T14:30:00Z",
          "opt_in_process": "double_opt_in"
        },
        "relationships": {
          "profiles": {
            "links": {
              "self": "https://a.klaviyo.com/api/lists/Y6nRLr/relationships/profiles/",
              "related": "https://a.klaviyo.com/api/lists/Y6nRLr/profiles/"
            }
          }
        }
      }
    ],
    "updated": [
      {
        "type": "list",
        "id": "UTd5ui",
        "attributes": {
          "name": "VIP Customers",
          "created": "2025-10-10T12:00:00Z",
          "updated": "2026-04-15T16:22:00Z",
          "opt_in_process": "single_opt_in"
        }
      }
    ]
  }
}

Notes​

  • The greater-than(updated,...) filter is applied server-side, so only records modified since the last poll are returned
  • A newly created record has created == updated, so the same record is never classified as both created and updated
  • Both profiles and lists use the created and updated attribute names — these differ from the created_at / updated_at names used by the Campaigns API
  • Refer to the Klaviyo API rate limits documentation for throttling behavior and the Get Profiles and Get Lists endpoint references for the full list of returned attributes

Data Sources​

Select Account​

Select an account to use. | key: selectAccount | type: picklist

InputNotesExample
Connection

Select Campaign​

Select a campaign to use. | key: selectCampaign | type: picklist

InputNotesExample
Connection

Select Event​

Select an event to use. | key: selectEvent | type: picklist

InputNotesExample
Connection

Select Image​

Select an image from your Klaviyo account. | key: selectImage | type: picklist

InputNotesExample
Connection
Example Payload for Select Image⤓
Loading…

Select List​

Select a list from your Klaviyo account. | key: selectList | type: picklist

InputNotesExample
Connection
Example Payload for Select List⤓
Loading…

Select Profile​

Select a profile to use. | key: selectProfile | type: picklist

InputNotesExample
Connection

Select Segment​

Select a segment from your Klaviyo account. | key: selectSegment | type: picklist

InputNotesExample
Connection
Example Payload for Select Segment⤓
Loading…

Select Template​

Select a template to use. | key: selectTemplate | type: picklist

InputNotesExample
Connection

Actions​

Bulk Create Events​

Create a batch of events for one or more profiles. | key: bulkCreateEvents

InputNotesExample
Connection
Events Array

An array of events to create.

[
  {
    "type": "event-bulk-create",
    "attributes": {
      "profile": {
        "data": {
          "type": "profile",
          "attributes": {
            "email": "sarah.mason@klaviyo-demo.com",
            "phoneNumber": "+15005550006",
            "firstName": "Sarah",
            "lastName": "Mason",
            "organization": "Example Corporation",
            "title": "Regional Manager",
            "image": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
            "location": {
              "address1": "89 E 42nd St",
              "address2": "1st floor",
              "city": "New York",
              "country": "United States",
              "latitude": "40.7128",
              "longitude": "74.0060",
              "region": "NY",
              "zip": "10017",
              "timezone": "America/New_York",
              "ip": "127.0.0.1"
            }
          },
          "meta": {
            "patchProperties": {
              "unset": [
                "skus"
              ]
            }
          }
        }
      },
      "events": {
        "data": [
          {
            "type": "event",
            "attributes": {
              "properties": {
                "newKey": "New Value"
              },
              "time": null,
              "value": 9.99,
              "valueCurrency": "USD",
              "metric": {
                "data": {
                  "type": "metric",
                  "attributes": {
                    "name": "Viewed Product"
                  }
                }
              },
              "uniqueId": "123"
            }
          }
        ]
      }
    }
  }
]
Example Payload for Bulk Create Events⤓
Loading…

Create Campaign​

Creates a campaign given a set of parameters, then returns it. | key: createCampaign

InputNotesExample
Campaign Messages

The message(s) to send in the campaign.

[
  {
    "type": "campaign-message",
    "attributes": {
      "channel": "email",
      "label": "My message name",
      "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"
      },
      "renderOptions": {
        "shortenLinks": true,
        "addOrgPrefix": true,
        "addInfoLink": true,
        "addOptOutLanguage": false
      }
    }
  }
]
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.

{
  "useSmartSending": true
}
Send Strategy

The send strategy for the campaign.

{
  "method": "static",
  "optionsStatic": {
    "datetime": "2022-11-08T00:00:00.000Z",
    "isLocal": false,
    "sendPastRecipientsImmediately": false
  },
  "optionsThrottled": {
    "datetime": "2022-11-08T00:00:00.000Z",
    "throttlePercentage": 10
  },
  "optionsSto": {
    "date": ""
  }
}
Tracking Options

The tracking options for the campaign.

{
  "isAddUtm": true,
  "utmParams": [
    {
      "name": "utm_medium",
      "value": "campaign"
    }
  ],
  "isTrackingClicks": true,
  "isTrackingOpens": true
}
Example Payload for Create Campaign⤓
Loading…

Create Event​

Create a new event to track a profiles activity. | key: createEvent

InputNotesExample
Connection
Event Name

Name of the event.

Viewed Product
Event Profile

The profile associated with this event.

{
  "phoneNumber": "+15005550006",
  "firstName": "Sarah",
  "lastName": "Mason",
  "organization": "Example Corporation",
  "title": "Regional Manager",
  "image": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
  "location": {
    "address1": "89 E 42nd St",
    "address2": "1st floor",
    "city": "New York",
    "country": "United States",
    "region": "NY",
    "zip": "10017",
    "timezone": "America/New_York",
    "ip": "127.0.0.1"
  },
  "properties": {
    "newKey": "New Value"
  },
  "meta": {
    "patchProperties": {
      "append": {
        "newKey": "New Value"
      },
      "unappend": {
        "newKey": "New Value"
      },
      "unset": [
        "skus"
      ]
    }
  },
  "email": "sarah.mason@klaviyo-demo.com"
}
Event Properties

The properties of the event.

{
  "newKey": "New Value"
}
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
Example Payload for Create Event⤓
Loading…

Create List​

Create a new list. | key: createList

InputNotesExample
Connection
List Name

A helpful name to label the list.

Newsletter
Example Payload for Create List⤓
Loading…

Create Profile​

Create a new profile. | key: createProfile

InputNotesExample
Connection
Email

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.

{
  "address1": "89 E 42nd St",
  "address2": "1st floor",
  "city": "New York",
  "country": "United States",
  "latitude": "40.7128",
  "longitude": "74.0060",
  "region": "NY",
  "zip": "10017",
  "timezone": "America/New_York",
  "ip": "127.0.0.1"
}
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.

{
  "newKey": "New Value"
}
Title

Individual's job title

Regional Manager
Example Payload for Create Profile⤓
Loading…

Create Segment​

Create a segment. | key: createSegment

InputNotesExample
Connection
Is Starred Segment

Whether the segment is starred.

false
Segment Condition Groups

The condition groups that define the segment.

[
  {
    "conditions": [
      {
        "type": "profile-group-membership",
        "isMember": true,
        "groupIds": [
          "X7MYfE"
        ],
        "timeframeFilter": {
          "type": "date",
          "operator": "in-the-last",
          "unit": "day",
          "quantity": 14
        }
      }
    ]
  }
]
Segment Name

The name of the segment.

A segment
Example Payload for Create Segment⤓
Loading…

Create Template​

Create a new custom HTML template. | key: createTemplate

InputNotesExample
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!
Example Payload for Create Template⤓
Loading…

Delete Campaign​

Delete a campaign with the given campaign ID. | key: deleteCampaign

InputNotesExample
Campaign ID

The ID of the campaign.

01J2DNH88028WCAA2RK0BYBZVG
Connection

Delete List​

Delete a list with the given list ID. | key: deleteList

InputNotesExample
Connection
List ID

The unique identifier of the list.

RE83th

Delete Segment​

Delete a segment with the given segment ID. | key: deleteSegment

InputNotesExample
Connection
Segment ID

The ID of the segment.

WwKnkd

Delete Template​

Delete a template with the given template ID. | key: deleteTemplate

InputNotesExample
Connection
Template ID

The ID of the template.

123456
Example Payload for Delete Template⤓
Loading…

Get Account​

Retrieve a single account object by its account ID. | key: getAccount

InputNotesExample
Account ID

The ID of the account to retrieve.

AbC123
Connection
Fields

The fields to include in the response.

Example Payload for Get Account⤓
Loading…

Get Campaign​

Returns a specific campaign based on a required id. | key: getCampaign

InputNotesExample
Campaign ID

The ID of the campaign.

01J2DNH88028WCAA2RK0BYBZVG
Connection
Fields

The fields to include in the response.

Example Payload for Get Campaign⤓
Loading…

Get Event​

Get an event with the given event ID. | key: getEvent

InputNotesExample
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.

Example Payload for Get Event⤓
Loading…

Get Image​

Get the image with the given image ID. | key: getImage

InputNotesExample
Connection
Fields

The fields to include in the response.

Image ID

The ID of the image.

155463624
Example Payload for Get Image⤓
Loading…

Get List​

Get a list with the given list ID. | key: getList

InputNotesExample
Connection
Fields

The fields to include in the response.

List ID

The unique identifier of the list.

RE83th
Example Payload for Get List⤓
Loading…

Get Profile​

Get the profile with the given profile ID. | key: getProfile

InputNotesExample
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
Example Payload for Get Profile⤓
Loading…

Get Segment​

Get a segment with the given segment ID. | key: getSegment

InputNotesExample
Connection
Fields

The fields to include in the response.

Segment ID

The ID of the segment.

WwKnkd
Example Payload for Get Segment⤓
Loading…

Get Template​

Get a template with the given template ID. | key: getTemplate

InputNotesExample
Connection
Fields

The fields to include in the response.

Template ID

The ID of the template.

123456
Example Payload for Get Template⤓
Loading…

List Accounts​

Retrieve the account(s) associated with a given private API key. | key: listAccounts

InputNotesExample
Connection
Fields

The fields to include in the response.

Example Payload for List Accounts⤓
Loading…

List Campaigns​

Returns some or all campaigns based on filters. | key: listCampaigns

InputNotesExample
Connection
Fields

The fields to include in the response.

Filter Campaigns

A filter to apply to the campaigns.

equals(messages.channel,'sms')
Example Payload for List Campaigns⤓
Loading…

List Events​

Get all events in an account. | key: listEvents

InputNotesExample
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.

Example Payload for List Events⤓
Loading…

List Images​

Get all images in an account. | key: listImages

InputNotesExample
Connection
Fields

The fields to include in the response.

Example Payload for List Images⤓
Loading…

List List Profiles​

Get all profiles within a list with the given list ID. | key: listListProfiles

InputNotesExample
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
Example Payload for List List Profiles⤓
Loading…

List Lists​

Get all lists in an account. | key: listLists

InputNotesExample
Connection
Fields

The fields to include in the response.

Example Payload for List Lists⤓
Loading…

List Profile​

Get all profiles in an account. | key: listProfile

InputNotesExample
Additional Profile Fields

Request additional fields not included by default in the response.

Connection
Fields

The fields to include in the response.

Example Payload for List Profile⤓
Loading…

List Segments​

Get all segments in an account. | key: listSegments

InputNotesExample
Connection
Fields

The fields to include in the response.

Example Payload for List Segments⤓
Loading…

List Templates​

Get all templates in an account. | key: listTemplates

InputNotesExample
Connection
Fields

The fields to include in the response.

Example Payload for List Templates⤓
Loading…

Raw Request​

Send raw HTTP request to Klaviyo. | key: rawRequest

InputNotesExample
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

InputNotesExample
Connection
Profiles

Array of profiles to subscribe.

[
  {
    "type": "profile",
    "id": "01GDDKASAP8TKDDA2GRZDSVP4H",
    "attributes": {
      "email": "matt-kemp@klaviyo-demo.com",
      "phoneNumber": "+15005550006",
      "subscriptions": {
        "email": {
          "marketing": {
            "consent": "SUBSCRIBED"
          }
        },
        "sms": {
          "marketing": {
            "consent": "SUBSCRIBED"
          }
        }
      }
    }
  }
]
Example Payload for Subscribe Profiles⤓
Loading…

Unsubscribe Profiles​

Unsubscribe one or more profiles to email marketing, SMS marketing, or both. | key: unsubscribeProfiles

InputNotesExample
Connection
Profiles

Array of profiles to unsubscribe.

[
  {
    "type": "profile",
    "attributes": {
      "email": "matt-kemp@klaviyo-demo.com",
      "phoneNumber": "+15005550006"
    }
  }
]
Example Payload for Unsubscribe Profiles⤓
Loading…

Update Campaign​

Update a campaign with the given campaign ID. | key: updateCampaign

InputNotesExample
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.

{
  "useSmartSending": true
}
Send Strategy

The send strategy for the campaign.

{
  "method": "static",
  "optionsStatic": {
    "datetime": "2022-11-08T00:00:00.000Z",
    "isLocal": false,
    "sendPastRecipientsImmediately": false
  },
  "optionsThrottled": {
    "datetime": "2022-11-08T00:00:00.000Z",
    "throttlePercentage": 10
  },
  "optionsSto": {
    "date": ""
  }
}
Tracking Options

The tracking options for the campaign.

{
  "isAddUtm": true,
  "utmParams": [
    {
      "name": "utm_medium",
      "value": "campaign"
    }
  ],
  "isTrackingClicks": true,
  "isTrackingOpens": true
}
Example Payload for Update Campaign⤓
Loading…

Update Image​

Update the image with the given image ID. | key: updateImage

InputNotesExample
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
Example Payload for Update Image⤓
Loading…

Update List​

Update the name of a list with the given list ID. | key: updateList

InputNotesExample
Connection
List ID

The unique identifier of the list.

RE83th
List Name

A helpful name to label the list.

Newsletter
Example Payload for Update List⤓
Loading…

Update Profile​

Update the profile with the given profile ID. | key: updateProfile

InputNotesExample
Connection
Email

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.

{
  "address1": "89 E 42nd St",
  "address2": "1st floor",
  "city": "New York",
  "country": "United States",
  "latitude": "40.7128",
  "longitude": "74.0060",
  "region": "NY",
  "zip": "10017",
  "timezone": "America/New_York",
  "ip": "127.0.0.1"
}
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.

{
  "newKey": "New Value"
}
Title

Individual's job title

Regional Manager
Example Payload for Update Profile⤓
Loading…

Update Segment​

Update a segment with the given segment ID. | key: updateSegment

InputNotesExample
Connection
Is Starred Segment

Whether the segment is starred.

Segment Condition Groups

The condition groups that define the segment.

[
  {
    "conditions": [
      {
        "type": "profile-group-membership",
        "isMember": true,
        "groupIds": [
          "X7MYfE"
        ],
        "timeframeFilter": {
          "type": "date",
          "operator": "in-the-last",
          "unit": "day",
          "quantity": 14
        }
      }
    ]
  }
]
Segment ID

The ID of the segment.

WwKnkd
Segment Name

The name of the segment.

A segment
Example Payload for Update Segment⤓
Loading…

Update Template​

Update a template with the given template ID. | key: updateTemplate

InputNotesExample
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!
Example Payload for Update Template⤓
Loading…

Upload Image​

Import an image from a url or file. | key: uploadImage

InputNotesExample
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 (data:image/...). Supported image formats: jpeg,png,gif. Maximum image size: 5MB. Use this field or File Data.

https://example.com/image.jpg
Example Payload for Upload Image⤓
Loading…

Changelog​

2026-05-05​

Added two new triggers using Klaviyo's server-side filter for efficient change detection:

  • New and Updated Profiles and Lists for profiles and lists
  • New and Updated Campaigns which requires a Message Channel input

2026-04-30​

Updated spectral version

2026-02-26​

Added inline data sources for segments, lists, and images to enable dynamic dropdown selection

2025-07-23​

Added inline data sources for accounts, campaigns, events, profiles, and templates to enhance data selection capabilities