Klaviyo - Documentation

Overview

Email and SMS marketing automation with Klaviyo. Call actions with automationType, action, and params from any workflow node that supports automations.

Authentication

Klaviyo Private API Key (per-account).

Available Actions

Click any action to jump to its example payload. Accounts

Get Account
Get Accounts
Request Deletion

Campaigns

Cancel Campaign Send
Clone Campaign
Create Campaign
Get Campaign Recipient Estimation
Get Campaigns
Send Campaign
Update Campaign

Catalog

Create Catalog Variant
Delete Catalog Item
Get Catalog Categories
Get Catalog Items
Get Catalog Variants
Update Catalog Category
Update Catalog Item

Coupons

Create Coupon Code
Delete Coupon
Delete Coupon Code
Get Coupon Codes

Events

Bulk Create Events
Create Event
Get Event
Get Events

Flows

Create Flow
Get Flow
Get Flow Messages
Get Flows
Update Flow Status

Forms

Get Form
Get Form Versions
Get Forms

Images

Get Images
Upload Image

Lists

Add to List
Create List
Delete List
Get List
Get List Profiles
Get Lists
Remove from List
Update List

Metrics

Get Metric
Get Metrics
Query Metric Aggregates

Profiles

Bulk Import Profiles
Create Profile
Create or Update Profile
Get Profiles
Merge Profiles
Suppress Profiles
Unsubscribe Profiles
Unsuppress Profiles
Update Profile

Reporting

Report Campaign Values
Report Flow Values
Report Form Values

Segments

Create Segment
Get Segment
Get Segments
Update Segment

Tags

Create Tag
Delete Tag
Get Tags
Tag Resources
Untag Resources

Templates

Create Template
Delete Template
Get Template
Get Templates
Render Template
Update Template

Webhooks

Create Webhook
Get Webhook
Get Webhook Topics
Get Webhooks

Examples

Example 1: Get Accounts

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_accounts",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY"
    }
  }
}

Example 2: Get Account

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_account",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "account_id": "YOUR_ACCOUNTID"
    }
  }
}

Example 3: Get Profiles

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_profiles",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY"
    }
  }
}

Example 4: Create Profile

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "create_profile",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "email": "postman-YOUR_$TIMESTAMP@test.com",
      "first_name": "Postman",
      "last_name": "Tester",
      "properties": {
        "source": "postman"
      }
    }
  }
}

Example 5: Get Profile

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_profile",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "profile_id": "YOUR_PROFILEID"
    }
  }
}

Example 6: Update Profile

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "update_profile",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "profile_id": "YOUR_PROFILEID",
      "first_name": "Updated",
      "organization": "Postman Corp"
    }
  }
}

Example 7: Create or Update Profile

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "create_or_update_profile",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "email": "upsert-YOUR_$TIMESTAMP@test.com",
      "first_name": "Upsert"
    }
  }
}

Example 8: Merge Profiles

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "merge_profiles",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "body": {
        "data": {
          "type": "profile-merge",
          "id": "YOUR_PROFILEID",
          "relationships": {
            "profiles": {
              "data": [
                {
                  "type": "profile",
                  "id": "REPLACE_WITH_SOURCE_ID"
                }
              ]
            }
          }
        }
      }
    }
  }
}

Example 9: Suppress Profiles

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "suppress_profiles",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "emails": [
        "suppress-YOUR_$TIMESTAMP@test.com"
      ]
    }
  }
}

Example 10: Unsuppress Profiles

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "unsuppress_profiles",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "emails": [
        "suppress-YOUR_$TIMESTAMP@test.com"
      ]
    }
  }
}

Example 11: Bulk Import Profiles

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "bulk_import_profiles",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "profiles": [
        {
          "email": "bulk1-YOUR_$TIMESTAMP@test.com",
          "first_name": "Bulk1"
        },
        {
          "email": "bulk2-YOUR_$TIMESTAMP@test.com",
          "first_name": "Bulk2"
        }
      ]
    }
  }
}

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "subscribe_profiles",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "list_id": "YOUR_LISTID",
      "emails": [
        "subscribe-YOUR_$TIMESTAMP@test.com"
      ],
      "channel": "email"
    }
  }
}

Example 13: Unsubscribe Profiles

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "unsubscribe_profiles",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "list_id": "YOUR_LISTID",
      "emails": [
        "subscribe-YOUR_$TIMESTAMP@test.com"
      ],
      "channel": "email"
    }
  }
}

Example 14: Get Events

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_events",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY"
    }
  }
}

Example 15: Create Event

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "create_event",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "metric_name": "Placed Order",
      "email": "event-YOUR_$TIMESTAMP@test.com",
      "properties": {
        "orderId": "ORD-YOUR_$TIMESTAMP",
        "value": 99.99
      },
      "value": 99.99
    }
  }
}

Example 16: Get Event

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_event",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "event_id": "YOUR_EVENTID"
    }
  }
}

Example 17: Bulk Create Events

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "bulk_create_events",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "events": [
        {
          "metricName": "Viewed Product",
          "profile": {
            "email": "bulk-event-YOUR_$TIMESTAMP@test.com"
          },
          "properties": {
            "productId": "P1"
          }
        },
        {
          "metricName": "Viewed Product",
          "profile": {
            "email": "bulk-event-YOUR_$TIMESTAMP@test.com"
          },
          "properties": {
            "productId": "P2"
          }
        }
      ]
    }
  }
}

Example 18: Get Metrics

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_metrics",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY"
    }
  }
}

Example 19: Get Metric

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_metric",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "metric_id": "YOUR_METRICID"
    }
  }
}

Example 20: Query Metric Aggregates

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "query_metric_aggregates",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "body": {
        "data": {
          "type": "metric-aggregate",
          "attributes": {
            "metric_id": "YOUR_METRICID",
            "measurements": [
              "count"
            ],
            "interval": "day",
            "filter": [
              "greater-or-equal(datetime,2026-01-01T00:00:00)",
              "less-than(datetime,2027-01-01T00:00:00)"
            ],
            "by": []
          }
        }
      }
    }
  }
}

Example 21: Get Lists

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_lists",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY"
    }
  }
}

Example 22: Create List

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "create_list",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "name": "Postman Test List YOUR_$TIMESTAMP"
    }
  }
}

Example 23: Get List

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_list",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "list_id": "YOUR_LISTID"
    }
  }
}

Example 24: Update List

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "update_list",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "list_id": "YOUR_LISTID",
      "name": "Postman Updated List"
    }
  }
}

Example 25: Delete List

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "delete_list",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "list_id": "YOUR_LISTID"
    }
  }
}

Example 26: Get List Profiles

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_list_profiles",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "list_id": "YOUR_LISTID"
    }
  }
}

Example 27: Add Profiles to List

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "add_to_list",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "list_id": "YOUR_LISTID",
      "profile_ids": [
        "YOUR_PROFILEID"
      ]
    }
  }
}

Example 28: Remove Profiles from List

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "remove_from_list",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "list_id": "YOUR_LISTID",
      "profile_ids": [
        "YOUR_PROFILEID"
      ]
    }
  }
}

Example 29: Get Segments

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_segments",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY"
    }
  }
}

Example 30: Create Segment

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "create_segment",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "attributes": {
        "name": "Postman Test Segment",
        "definition": {
          "condition_groups": []
        }
      }
    }
  }
}

Example 31: Get Segment

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_segment",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "segment_id": "YOUR_SEGMENTID"
    }
  }
}

Example 32: Update Segment

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "update_segment",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "segment_id": "YOUR_SEGMENTID",
      "attributes": {
        "name": "Postman Updated Segment"
      }
    }
  }
}

Example 33: Delete Segment

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "delete_segment",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "segment_id": "YOUR_SEGMENTID"
    }
  }
}

Example 34: Get Segment Profiles

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_segment_profiles",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "segment_id": "YOUR_SEGMENTID"
    }
  }
}

Example 35: Get Campaigns

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_campaigns",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "query": {
        "filter": "equals(messages.channel,'email')"
      }
    }
  }
}

Example 36: Create Campaign

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "create_campaign",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "attributes": {
        "name": "Postman Test Campaign",
        "audiences": {
          "included": [
            "YOUR_LISTID"
          ]
        },
        "campaign-messages": {
          "data": [
            {
              "type": "campaign-message",
              "attributes": {
                "definition": {
                  "channel": "email",
                  "label": "Test message",
                  "content": {
                    "subject": "Test subject",
                    "preview_text": "Preview",
                    "from_email": "sender@example.com",
                    "from_label": "Sender"
                  }
                }
              }
            }
          ]
        },
        "send_strategy": {
          "method": "static",
          "datetime": "2027-01-01T00:00:00+00:00"
        },
        "send_options": {
          "use_smart_sending": false
        },
        "tracking_options": {
          "is_tracking_clicks": true,
          "is_tracking_opens": true
        }
      }
    }
  }
}

Example 37: Get Campaign

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_campaign",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "campaign_id": "YOUR_CAMPAIGNID"
    }
  }
}

Example 38: Update Campaign

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "update_campaign",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "campaign_id": "YOUR_CAMPAIGNID",
      "attributes": {
        "name": "Postman Updated Campaign"
      }
    }
  }
}

Example 39: Delete Campaign

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "delete_campaign",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "campaign_id": "YOUR_CAMPAIGNID"
    }
  }
}

Example 40: Clone Campaign

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "clone_campaign",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "campaign_id": "YOUR_CAMPAIGNID"
    }
  }
}

Example 41: Send Campaign

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "send_campaign",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "campaign_id": "YOUR_CAMPAIGNID"
    }
  }
}

Example 42: Cancel Campaign Send

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "cancel_campaign_send",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "campaign_id": "YOUR_CAMPAIGNID"
    }
  }
}

Example 43: Get Campaign Messages

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_campaign_messages",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "campaign_id": "YOUR_CAMPAIGNID"
    }
  }
}

Example 44: Get Campaign Recipient Estimation

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_campaign_recipient_estimation",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "campaign_id": "YOUR_CAMPAIGNID"
    }
  }
}

Example 45: Get Flows

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_flows",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY"
    }
  }
}

Example 46: Create Flow

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "create_flow",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "attributes": {
        "name": "Postman Test Flow"
      }
    }
  }
}

Example 47: Get Flow

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_flow",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "flow_id": "YOUR_FLOWID"
    }
  }
}

Example 48: Update Flow Status

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "update_flow_status",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "flow_id": "YOUR_FLOWID",
      "status": "draft"
    }
  }
}

Example 49: Delete Flow

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "delete_flow",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "flow_id": "YOUR_FLOWID"
    }
  }
}

Example 50: Get Flow Actions

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_flow_actions",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "flow_id": "YOUR_FLOWID"
    }
  }
}

Example 51: Get Flow Messages

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_flow_messages",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "action_id": "YOUR_FLOWACTIONID"
    }
  }
}

Example 52: Get Templates

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_templates",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY"
    }
  }
}

Example 53: Create Template

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "create_template",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "attributes": {
        "name": "Postman Test Template",
        "editor_type": "CODE",
        "html": "<html><body><p>Hello YOUR_FIRST_NAME</p></body></html>"
      }
    }
  }
}

Example 54: Get Template

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_template",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "template_id": "YOUR_TEMPLATEID"
    }
  }
}

Example 55: Update Template

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "update_template",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "template_id": "YOUR_TEMPLATEID",
      "attributes": {
        "name": "Postman Updated Template"
      }
    }
  }
}

Example 56: Delete Template

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "delete_template",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "template_id": "YOUR_TEMPLATEID"
    }
  }
}

Example 57: Render Template

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "render_template",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "template_id": "YOUR_TEMPLATEID",
      "context": {
        "first_name": "Postman"
      }
    }
  }
}

Example 58: Clone Template

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "clone_template",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "template_id": "YOUR_TEMPLATEID"
    }
  }
}

Example 59: Get Catalog Items

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_catalog_items",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY"
    }
  }
}

Example 60: Create Catalog Item

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "create_catalog_item",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "attributes": {
        "external_id": "POSTMAN-ITEM-YOUR_$TIMESTAMP",
        "title": "Postman Test Product",
        "description": "Postman test product description",
        "url": "https://example.com/product",
        "price": 29.99
      }
    }
  }
}

Example 61: Get Catalog Item

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_catalog_item",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "item_id": "YOUR_CATALOGITEMID"
    }
  }
}

Example 62: Update Catalog Item

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "update_catalog_item",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "item_id": "YOUR_CATALOGITEMID",
      "attributes": {
        "title": "Postman Updated Product"
      }
    }
  }
}

Example 63: Delete Catalog Item

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "delete_catalog_item",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "item_id": "YOUR_CATALOGITEMID"
    }
  }
}

Example 64: Get Catalog Variants

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_catalog_variants",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY"
    }
  }
}

Example 65: Create Catalog Variant

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "create_catalog_variant",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "attributes": {
        "external_id": "POSTMAN-VAR-YOUR_$TIMESTAMP",
        "title": "Postman Variant",
        "price": 19.99,
        "catalog_type": "$default"
      }
    }
  }
}

Example 66: Update Catalog Variant

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "update_catalog_variant",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "variant_id": "YOUR_CATALOGVARIANTID",
      "attributes": {
        "title": "Postman Updated Variant"
      }
    }
  }
}

Example 67: Delete Catalog Variant

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "delete_catalog_variant",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "variant_id": "YOUR_CATALOGVARIANTID"
    }
  }
}

Example 68: Get Catalog Categories

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_catalog_categories",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY"
    }
  }
}

Example 69: Create Catalog Category

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "create_catalog_category",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "attributes": {
        "external_id": "POSTMAN-CAT-YOUR_$TIMESTAMP",
        "name": "Postman Test Category"
      }
    }
  }
}

Example 70: Update Catalog Category

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "update_catalog_category",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "category_id": "YOUR_CATALOGCATEGORYID",
      "attributes": {
        "name": "Postman Updated Category"
      }
    }
  }
}

Example 71: Delete Catalog Category

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "delete_catalog_category",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "category_id": "YOUR_CATALOGCATEGORYID"
    }
  }
}

Example 72: Get Coupons

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_coupons",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY"
    }
  }
}

Example 73: Create Coupon

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "create_coupon",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "attributes": {
        "external_id": "POSTMANCOUPYOUR_$TIMESTAMP",
        "description": "Postman test coupon"
      }
    }
  }
}

Example 74: Get Coupon

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_coupon",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "coupon_id": "YOUR_COUPONID"
    }
  }
}

Example 75: Update Coupon

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "update_coupon",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "coupon_id": "YOUR_COUPONID",
      "attributes": {
        "description": "Updated coupon"
      }
    }
  }
}

Example 76: Delete Coupon

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "delete_coupon",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "coupon_id": "YOUR_COUPONID"
    }
  }
}

Example 77: Create Coupon Code

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "create_coupon_code",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "coupon_id": "YOUR_COUPONID",
      "attributes": {
        "unique_code": "POSTMANYOUR_$TIMESTAMP"
      }
    }
  }
}

Example 78: Get Coupon Codes

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_coupon_codes",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "query": {
        "filter": "equals(coupon.id,\"YOUR_COUPONID\")"
      }
    }
  }
}

Example 79: Delete Coupon Code

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "delete_coupon_code",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "code_id": "YOUR_COUPONCODEID"
    }
  }
}

Example 80: Get Tags

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_tags",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY"
    }
  }
}

Example 81: Create Tag

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "create_tag",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "name": "postman-tag-YOUR_$TIMESTAMP"
    }
  }
}

Example 82: Delete Tag

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "delete_tag",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "tag_id": "YOUR_TAGID"
    }
  }
}

Example 83: Tag Resources

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "tag_resources",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "tag_id": "YOUR_TAGID",
      "resource_type": "lists",
      "resource_ids": [
        "YOUR_LISTID"
      ]
    }
  }
}

Example 84: Untag Resources

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "untag_resources",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "tag_id": "YOUR_TAGID",
      "resource_type": "lists",
      "resource_ids": [
        "YOUR_LISTID"
      ]
    }
  }
}

Example 85: Get Images

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_images",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY"
    }
  }
}

Example 86: Upload Image

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "upload_image",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "image_url": "https://via.placeholder.com/100x100.png",
      "name": "postman-image-YOUR_$TIMESTAMP"
    }
  }
}

Example 87: Get Forms

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_forms",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY"
    }
  }
}

Example 88: Get Form

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_form",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "form_id": "YOUR_FORMID"
    }
  }
}

Example 89: Get Form Versions

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_form_versions",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "form_id": "YOUR_FORMID"
    }
  }
}

Example 90: Get Webhooks

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_webhooks",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY"
    }
  }
}

Example 91: Create Webhook

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "create_webhook",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "attributes": {
        "name": "postman-webhook-YOUR_$TIMESTAMP",
        "endpoint_url": "https://httpbin.org/post?t=YOUR_$TIMESTAMP",
        "description": "Postman test webhook"
      }
    }
  }
}

Example 92: Get Webhook

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_webhook",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "webhook_id": "YOUR_WEBHOOKID"
    }
  }
}

Example 93: Update Webhook

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "update_webhook",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "webhook_id": "YOUR_WEBHOOKID",
      "attributes": {
        "name": "postman-updated-webhook"
      }
    }
  }
}

Example 94: Delete Webhook

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "delete_webhook",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "webhook_id": "YOUR_WEBHOOKID"
    }
  }
}

Example 95: Get Webhook Topics

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "get_webhook_topics",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY"
    }
  }
}

Example 96: Report Campaign Values

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "report_campaign_values",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "body": {
        "data": {
          "type": "campaign-values-report",
          "attributes": {
            "statistics": [
              "opens",
              "clicks"
            ],
            "timeframe": {
              "key": "last_30_days"
            },
            "conversion_metric_id": "YOUR_METRICID"
          }
        }
      }
    }
  }
}

Example 97: Report Flow Values

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "report_flow_values",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "body": {
        "data": {
          "type": "flow-values-report",
          "attributes": {
            "statistics": [
              "recipients"
            ],
            "timeframe": {
              "key": "last_30_days"
            },
            "conversion_metric_id": "YOUR_METRICID"
          }
        }
      }
    }
  }
}

Example 98: Report Flow Series

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "report_flow_series",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "body": {
        "data": {
          "type": "flow-series-report",
          "attributes": {
            "statistics": [
              "recipients"
            ],
            "timeframe": {
              "key": "last_30_days"
            },
            "interval": "daily",
            "conversion_metric_id": "YOUR_METRICID"
          }
        }
      }
    }
  }
}

Example 99: Report Form Values

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "report_form_values",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "body": {
        "data": {
          "type": "form-values-report",
          "attributes": {
            "statistics": [
              "submits"
            ],
            "timeframe": {
              "key": "last_30_days"
            }
          }
        }
      }
    }
  }
}

Example 100: Request Profile Deletion

{
  "automationType": "klaviyo",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "request_deletion",
    "params": {
      "apiKey": "YOUR_KLAVIYO_PRIVATE_API_KEY",
      "email": "delete-me-YOUR_$TIMESTAMP@test.com"
    }
  }
}

Third-Party Documentation

https://developers.klaviyo.com/en/reference/api_overview

Get Started

The Platform

Documentation Index

​Overview

​Authentication

​Available Actions

​Examples

​Example 1: Get Accounts

​Example 2: Get Account

​Example 3: Get Profiles

​Example 4: Create Profile

​Example 5: Get Profile

​Example 6: Update Profile

​Example 7: Create or Update Profile

​Example 8: Merge Profiles

​Example 9: Suppress Profiles

​Example 10: Unsuppress Profiles

​Example 11: Bulk Import Profiles

​Example 12: Subscribe Profiles

​Example 13: Unsubscribe Profiles

​Example 14: Get Events

​Example 15: Create Event

​Example 16: Get Event

​Example 17: Bulk Create Events

​Example 18: Get Metrics

​Example 19: Get Metric

​Example 20: Query Metric Aggregates

​Example 21: Get Lists

​Example 22: Create List

​Example 23: Get List

​Example 24: Update List

​Example 25: Delete List

​Example 26: Get List Profiles

​Example 27: Add Profiles to List

​Example 28: Remove Profiles from List

​Example 29: Get Segments

​Example 30: Create Segment

​Example 31: Get Segment

​Example 32: Update Segment

​Example 33: Delete Segment

​Example 34: Get Segment Profiles

​Example 35: Get Campaigns

​Example 36: Create Campaign

​Example 37: Get Campaign

​Example 38: Update Campaign

​Example 39: Delete Campaign

​Example 40: Clone Campaign

​Example 41: Send Campaign

​Example 42: Cancel Campaign Send

​Example 43: Get Campaign Messages

​Example 44: Get Campaign Recipient Estimation

​Example 45: Get Flows

​Example 46: Create Flow

​Example 47: Get Flow

​Example 48: Update Flow Status

​Example 49: Delete Flow

​Example 50: Get Flow Actions

​Example 51: Get Flow Messages

​Example 52: Get Templates

​Example 53: Create Template

​Example 54: Get Template

​Example 55: Update Template

​Example 56: Delete Template

​Example 57: Render Template

​Example 58: Clone Template

​Example 59: Get Catalog Items

​Example 60: Create Catalog Item

​Example 61: Get Catalog Item

​Example 62: Update Catalog Item

​Example 63: Delete Catalog Item

​Example 64: Get Catalog Variants

​Example 65: Create Catalog Variant

​Example 66: Update Catalog Variant

​Example 67: Delete Catalog Variant

​Example 68: Get Catalog Categories

​Example 69: Create Catalog Category

​Example 70: Update Catalog Category

​Example 71: Delete Catalog Category

​Example 72: Get Coupons

​Example 73: Create Coupon