HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference
These docs are for v1-2. Click to read the latest docs for v2026-04-15.

Subscribe Profiles to List

Subscribes profiles to a list. Profiles will be single or double opted into the specified list in accordance with that list’s settings. Note: If you have double opt-in enabled (default behavior), users will not be added to list until they opt-in, and so API will respond with an empty list: []

Path Params
string
required
Defaults to LIST_ID
Body Params

The profiles that you would like to subscribe. Each object in the list must have either an email or phone number key. You can also provide additional properties as key-value pairs. If you are a GDPR compliant business, you will need to include $consent in your API call. $consent is a list-type, Klaviyo special property and only accepts some subset of the following: ["email", "web", "sms", "directmail", "mobile"]. If you are updating consent for a phone number or would like to send an opt-in SMS to the profile (for double opt-in lists), include an sms_consent key in the profile with a value of true or false.

profiles
array of objects
required
Defaults to [object Object],[object Object]
profiles*
string
string
boolean
Response

Language
Credentials
Query
LoadingLoading…
Response
Choose an example:
application/json