HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Create Client Subscription

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

Scopes:
subscriptions:write

Query Params
string
required
Defaults to PUBLIC_API_KEY

Your Public API Key / Site ID. See this article for more details.

Body Params

Creates a subscription and consent records for Email and or SMS channels based on the provided email and phone_number
attributes respectively. One of either email or phone_number must be provided. To create a subscription and consent
record for only one channel but still include the other channel as a profile property the consent channel can
be provided as a top level attribute and the other channel can be included in the properties object.

object
required
string
required
object
required
string
Defaults to Homepage footer signup form

A custom method detail or source to store on the consent records for this subscription.

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 sarah.mason@klaviyo-demo.com

Individual's email address

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
Defaults to 01GDDKASAP8TKDDA2GRZDSVP4H

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

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

object
required
object
required
object
required
string
required
string
required
Defaults to Y6nRLr

The list ID to add the newly subscribed profile to.

Headers
string
required
Defaults to 2024-02-15

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

Response
202

Success

Language