Create and update properties about a profile without tracking an associated event.\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only. To create profiles from server applications (e.g. custom server-side scripts / applications), please use POST /api/profiles
Rate limits:
Burst: 350/s
Steady: 3500/m
\n\nScopes:\nProfiles Write
type: object
properties:
parameters:
type: object
properties:
company_id:
type: string
revision:
type: string
default: '2023-02-22'
description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
required:
- company_id
- revision
title: Parameters
data:
type: object
required:
- data
properties:
data:
type: object
required:
- type
- attributes
properties:
type:
type: string
enum:
- profile
attributes:
type: object
properties:
email:
type: string
example:
[email protected]
description: Individual's email address
phone_number:
type: string
example: '+15005550006'
description: Individual's phone number in E.164 format
external_id:
type: string
example: 63f64a2b-c6bf-40c7-b81f-bed08162edbe
description: >-
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.
anonymous_id:
type: string
first_name:
type: string
example: Sarah
description: Individual's first name
last_name:
type: string
example: Mason
description: Individual's last name
organization:
type: string
example: Klaviyo
description: >-
Name of the company or organization within the company for
whom the individual works
title:
type: string
example: Engineer
description: Individual's job title
image:
type: string
example: >-
https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg
description: URL pointing to the location of a profile image
location:
type: object
properties:
address1:
type: string
example: 89 E 42nd St
description: First line of street address
address2:
type: string
example: 1st floor
description: Second line of street address
city:
type: string
example: New York
description: City name
country:
type: string
example: United States
description: Country name
latitude:
oneOf:
- type: string
- type: number
example: '40.7128'
description: >-
Latitude coordinate. We recommend providing a precision of
four decimal places.
longitude:
oneOf:
- type: string
- type: number
example: '74.0060'
description: >-
Longitude coordinate. We recommend providing a precision
of four decimal places.
region:
type: string
example: NY
description: Region within a country, such as state or province
zip:
type: string
example: '10017'
description: Zip code
timezone:
type: string
example: America/New_York
description: >-
Time zone name. We recommend using time zones from the
IANA Time Zone Database.
properties:
type: object
example:
pseudonym: Dr. Octopus
description: >-
An object containing key/value pairs for any custom properties
assigned to this profile
meta:
type: object
required:
- identifiers
properties:
identifiers:
type: object
properties:
id:
type: string
example: 01GDDKASAP8TKDDA2GRZDSVP4H
description: >-
Primary key that uniquely identifies this profile.
Generated by Klaviyo.
email:
type: string
example:
[email protected]
description: Individual's email address
phone_number:
type: string
example: '+15005550006'
description: Individual's phone number in E.164 format
external_id:
type: string
example: 63f64a2b-c6bf-40c7-b81f-bed08162edbe
description: >-
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.
anonymous_id:
type: string
_kx:
type: string
example: J8fjcn003Wy6b-3ILNlOyZXabW6dcFwTyeuxrowMers%3D.McN66
description: >-
\nAlso known as the `exchange_id`, this is an encrypted
identifier used for identifying a\nprofile by Klaviyo's
web tracking.\n\nYou can use this field as a filter when
retrieving profiles via the Get Profiles endpoint.\n
title: Data