These docs are for a deprecated API version. Click here to use the latest version.

Subscribe Profiles to List

post https://a.klaviyo.com/api/v2/list/{list_id}/subscribe

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: []

Response

Language

Credentials

Query


xxxxxxxxxx
17
1
curl --request POST \
2
     --url 'https://a.klaviyo.com/api/v2/list/LIST_ID/subscribe?api_key=PRIVATE_API_KEY' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "profiles": [
8
    {
9
      "email": "george.washington@klaviyo.com"
10
    },
11
    {
12
      "phone_number": "+13239169023",
13
      "sms_consent": true
14
    }
15
  ]
16
}
17
'


xxxxxxxxxx
 
1
[]

200Successful requests will return with HTTP OK responses. If the list is single opt-in then a list of records containing the email address, phone number, push token, and the corresponding profile ID will also be included. Invalid requests will be accompanied by an error message.