HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Create or Update Push Token

Create or update a push token.

This endpoint can be used to migrate push tokens from another platform to Klaviyo. Please use our mobile SDKs (iOS and Android) to create push tokens from users' devices.

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

Scopes:
profiles:write
push-tokens:write

Body Params
object
required
string
required
object
required
string
required

A push token from APNS or FCM.

string
required

The platform on which the push token was created.

string
Defaults to AUTHORIZED

This is the enablement status for the individual push token.

string
required

The vendor of the push token.

string
Defaults to AVAILABLE

The background state of the push token.

object

Metadata about the device that created the push token

string

Relatively stable ID for the device. Will update on app uninstall and reinstall

string

The name of the SDK used to create the push token.

string

The version of the SDK used to create the push token

string

The model of the device

string

The name of the operating system on the device.

string

The version of the operating system on the device

string

The manufacturer of the device

string

The name of the app that created the push token

string

The version of the app that created the push token

string

The build of the app that created the push token

string

The ID of the app that created the push token

string

The environment in which the push token was created

object
required

The profile associated with the push token to create/update

object
required
string
required
string

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

object
required
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

string

Individual's email address

Headers
string
required
Defaults to 2025-01-15

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

Responses
202

Success

Language
Credentials