HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Create or Update Profile

Given a set of profile attributes and optionally an ID, create or update a profile.

Returns 201 if a new profile was created, 200 if an existing profile was updated.

Use the additional-fields parameter to include subscriptions and predictive analytics data in your response.

Note that setting a field to null will clear out the field, whereas not including a field in your request will leave it unchanged.

Rate limits:
Burst: 75/s
Steady: 700/m

Scopes:
profiles:write

Query Params
array of strings

Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'

additional-fields[profile]
Body Params
object
required
string
required
string

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

object
required
string

Individual's email address

string

Individual's phone number in E.164 format

string

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

Id that can be used to identify a profile when other identifiers are not available

string

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

Individual's first name

string

Individual's last name

string

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

string

The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)

string

Individual's job title

string

URL pointing to the location of a profile image

object
string

First line of street address

string

Second line of street address

string

City name

string

Country name

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

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

string

Region within a country, such as state or province

string

Zip code

string

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

string

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

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

Headers
string
required
Defaults to 2025-01-15

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

Responses

Language
Credentials