HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Create Event

Create a new event to track a profile's activity.

Successful response indicates that the event was validated and submitted for processing, but does not guarantee that processing is complete.

Rate limits:
Burst: 350/s
Steady: 3500/m

Scopes:
events:write

Body Params
object
required
string
required
object
required
object
required

Properties of this event. Any top level property (that are not objects) can be
used to create segments. The $extra property is a special property. This records any
non-segmentable values that can be referenced later. For example, HTML templates are
useful on a segment but are not used to create a segment. There are limits
placed onto the size of the data present. This must not exceed 5 MB. This must not
exceed 300 event properties. A single string cannot be larger than 100 KB. Each array
must not exceed 4000 elements. The properties cannot contain more than 10 nested levels.

string
date-time
Defaults to 2022-11-08T00:00:00+00:00

When this event occurred. By default, the time the request was received will be used.
The time is truncated to the second. The time must be after the year 2000 and can only
be up to 1 year in the future.

number
Defaults to 9.99

A numeric, monetary value to associate with this event. For example, the dollar amount of a purchase.

string
Defaults to USD

The ISO 4217 currency code of the value associated with the event.

string

A unique identifier for an event. If the unique_id is repeated for the same
profile and metric, only the first processed event will be recorded. If this is not
present, this will use the time to the second. Using the default, this limits only one
event per profile per second.

object
required
object
required
string
required
object
required
string
required
Defaults to Viewed Product

Name of the event. Must be less than 128 characters.

string

This is for advanced usage. For api requests, this should use the default, which is set to api.

object
required
object
required
string
required
string
Defaults to 01GDDKASAP8TKDDA2GRZDSVP4H

Primary key that uniquely identifies this profile. Generated by Klaviyo.

object
required
string
Defaults to +15005550006

Individual's phone number in E.164 format

string
Defaults to 63f64a2b-c6bf-40c7-b81f-bed08162edbe

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.

string
string
Defaults to J8fjcn003Wy6b-3ILNlOyZXabW6dcFwTyeuxrowMers%3D.McN66

Also known as the exchange_id, this is an encrypted identifier used for identifying a
profile by Klaviyo's web tracking.

You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.

string
Defaults to Sarah

Individual's first name

string
Defaults to Mason

Individual's last name

string
Defaults to Example Corporation

Name of the company or organization within the company for whom the individual works

string
Defaults to Regional Manager

Individual's job title

string
Defaults to https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg

URL pointing to the location of a profile image

object
string
Defaults to 89 E 42nd St

First line of street address

string
Defaults to 1st floor

Second line of street address

string
Defaults to New York

City name

string
Defaults to United States

Country name

Defaults to 40.7128

Latitude coordinate. We recommend providing a precision of four decimal places.

Defaults to 74.0060

Longitude coordinate. We recommend providing a precision of four decimal places.

string
Defaults to NY

Region within a country, such as state or province

string
Defaults to 10017

Zip code

string
Defaults to America/New_York

Time zone name. We recommend using time zones from the IANA Time Zone Database.

string
Defaults to 127.0.0.1

IP Address

object

An object containing key/value pairs for any custom properties assigned to this profile

string
object
object

Specify one or more patch operations to apply to existing property data

object

Append a simple value or values to this property array

string
object

Remove a simple value or values from this property array

string
string
Defaults to skus

Remove a key or keys (and their values) completely from properties

string
Defaults to sarah.mason@klaviyo-demo.com

Individual's email address

Headers
string
required
Defaults to 2024-02-15

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses
202

Success

Language
Credentials