HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference
These docs are for a deprecated API version. Click here to use the latest version.

Create Client Subscription

Create a new subscription for the given list ID and channel:

  • Email email
  • SMS phone_number

This endpoint is specifically designed to be called from publicly-browseable, client-side environments only. To create subscriptions from server-based applications, please use POST /api/profile-subscription-bulk-create-jobs

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

Scopes:
Subscriptions Write

Query Params
string
required
Defaults to COMPANY_ID

Your company ID.

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
required
Defaults to Y6nRLr

The list ID to add the newly subscribed profile to.

string
Defaults to Homepage footer signup form

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

string
Defaults to matt.kemp@klaviyo-demo.com

Email address to create subscription and email consent record for.

string
Defaults to +15005550006

Phone number to create subscription and SMS consent record for, in E.164 format.

object

Profile properties to set on the newly subscribed profile.

string
Headers
string
required
Defaults to 2023-01-24

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

Response
202
Language