Create Client Subscription

POST {{baseUrl}}/client/subscriptions/?company_id={{companyId}}

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

Request Params

KeyDatatypeRequiredDescription
company_idstring(Required) Your company ID.

Request Body

{"data"=>{"type"=>"subscription", "attributes"=>{"list_id"=>"Y6nRLr", "custom_source"=>"Homepage footer signup form", "email"=>"matt.kemp@klaviyo-demo.com", "phone_number"=>"+15005550006", "properties"=>{"first_name"=>"Matt", "last_name"=>"Kemp", "favorite_color"=>"Blue"}}}}

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Content-Typestring