Bulk create subscribers
curl --request POST \
--url https://api.kit.com/v4/bulk/subscribers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subscribers": [
{
"first_name": "Test Subscriber 0",
"email_address": "subscriber_0@convertkit.dev"
},
{
"first_name": "Test Subscriber 1",
"email_address": "subscriber_1@convertkit.dev"
},
{
"first_name": "Test Subscriber 2",
"email_address": "subscriber_2@convertkit.dev"
},
{
"first_name": "Test Subscriber 3",
"email_address": "subscriber_3@convertkit.dev"
}
],
"callback_url": null
}
'require 'uri'
require 'net/http'
url = URI("https://api.kit.com/v4/bulk/subscribers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subscribers\": [\n {\n \"first_name\": \"Test Subscriber 0\",\n \"email_address\": \"subscriber_0@convertkit.dev\"\n },\n {\n \"first_name\": \"Test Subscriber 1\",\n \"email_address\": \"subscriber_1@convertkit.dev\"\n },\n {\n \"first_name\": \"Test Subscriber 2\",\n \"email_address\": \"subscriber_2@convertkit.dev\"\n },\n {\n \"first_name\": \"Test Subscriber 3\",\n \"email_address\": \"subscriber_3@convertkit.dev\"\n }\n ],\n \"callback_url\": null\n}"
response = http.request(request)
puts response.read_bodyconst options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subscribers: [
{first_name: 'Test Subscriber 0', email_address: 'subscriber_0@convertkit.dev'},
{first_name: 'Test Subscriber 1', email_address: 'subscriber_1@convertkit.dev'},
{first_name: 'Test Subscriber 2', email_address: 'subscriber_2@convertkit.dev'},
{first_name: 'Test Subscriber 3', email_address: 'subscriber_3@convertkit.dev'}
],
callback_url: null
})
};
fetch('https://api.kit.com/v4/bulk/subscribers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kit.com/v4/bulk/subscribers"
payload := strings.NewReader("{\n \"subscribers\": [\n {\n \"first_name\": \"Test Subscriber 0\",\n \"email_address\": \"subscriber_0@convertkit.dev\"\n },\n {\n \"first_name\": \"Test Subscriber 1\",\n \"email_address\": \"subscriber_1@convertkit.dev\"\n },\n {\n \"first_name\": \"Test Subscriber 2\",\n \"email_address\": \"subscriber_2@convertkit.dev\"\n },\n {\n \"first_name\": \"Test Subscriber 3\",\n \"email_address\": \"subscriber_3@convertkit.dev\"\n }\n ],\n \"callback_url\": null\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kit.com/v4/bulk/subscribers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'subscribers' => [
[
'first_name' => 'Test Subscriber 0',
'email_address' => 'subscriber_0@convertkit.dev'
],
[
'first_name' => 'Test Subscriber 1',
'email_address' => 'subscriber_1@convertkit.dev'
],
[
'first_name' => 'Test Subscriber 2',
'email_address' => 'subscriber_2@convertkit.dev'
],
[
'first_name' => 'Test Subscriber 3',
'email_address' => 'subscriber_3@convertkit.dev'
]
],
'callback_url' => null
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://api.kit.com/v4/bulk/subscribers"
payload = {
"subscribers": [
{
"first_name": "Test Subscriber 0",
"email_address": "subscriber_0@convertkit.dev"
},
{
"first_name": "Test Subscriber 1",
"email_address": "subscriber_1@convertkit.dev"
},
{
"first_name": "Test Subscriber 2",
"email_address": "subscriber_2@convertkit.dev"
},
{
"first_name": "Test Subscriber 3",
"email_address": "subscriber_3@convertkit.dev"
}
],
"callback_url": None
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"subscribers": [
{
"id": 596,
"first_name": null,
"email_address": "brooke@convertkit.dev",
"state": "active",
"created_at": "2023-02-17T11:43:55Z"
},
{
"id": 597,
"first_name": "Camille",
"email_address": "camille@convertkit.dev",
"state": "active",
"created_at": "2023-02-17T11:43:55Z"
},
{
"id": 595,
"first_name": "Alice",
"email_address": "alice@convertkit.dev",
"state": "active",
"created_at": "2023-02-17T11:43:55Z"
}
],
"failures": [
{
"subscriber": {
"first_name": "Benito",
"email_address": null,
"state": "active",
"created_at": null
},
"errors": [
"Email address is invalid"
]
}
]
}{}{
"errors": [
"The access token is invalid"
]
}{
"errors": [
"This request would exceed your subscriber limit"
]
}{
"errors": [
"This request exceeds your queued bulk requests limit. Please wait while we process your existing requests and try again later."
]
}{
"errors": [
"No subscribers included for processing"
]
}Subscribers
Bulk create subscribers
See “Bulk & async processing” for more information.
POST
/
v4
/
bulk
/
subscribers
Bulk create subscribers
curl --request POST \
--url https://api.kit.com/v4/bulk/subscribers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subscribers": [
{
"first_name": "Test Subscriber 0",
"email_address": "subscriber_0@convertkit.dev"
},
{
"first_name": "Test Subscriber 1",
"email_address": "subscriber_1@convertkit.dev"
},
{
"first_name": "Test Subscriber 2",
"email_address": "subscriber_2@convertkit.dev"
},
{
"first_name": "Test Subscriber 3",
"email_address": "subscriber_3@convertkit.dev"
}
],
"callback_url": null
}
'require 'uri'
require 'net/http'
url = URI("https://api.kit.com/v4/bulk/subscribers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subscribers\": [\n {\n \"first_name\": \"Test Subscriber 0\",\n \"email_address\": \"subscriber_0@convertkit.dev\"\n },\n {\n \"first_name\": \"Test Subscriber 1\",\n \"email_address\": \"subscriber_1@convertkit.dev\"\n },\n {\n \"first_name\": \"Test Subscriber 2\",\n \"email_address\": \"subscriber_2@convertkit.dev\"\n },\n {\n \"first_name\": \"Test Subscriber 3\",\n \"email_address\": \"subscriber_3@convertkit.dev\"\n }\n ],\n \"callback_url\": null\n}"
response = http.request(request)
puts response.read_bodyconst options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subscribers: [
{first_name: 'Test Subscriber 0', email_address: 'subscriber_0@convertkit.dev'},
{first_name: 'Test Subscriber 1', email_address: 'subscriber_1@convertkit.dev'},
{first_name: 'Test Subscriber 2', email_address: 'subscriber_2@convertkit.dev'},
{first_name: 'Test Subscriber 3', email_address: 'subscriber_3@convertkit.dev'}
],
callback_url: null
})
};
fetch('https://api.kit.com/v4/bulk/subscribers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kit.com/v4/bulk/subscribers"
payload := strings.NewReader("{\n \"subscribers\": [\n {\n \"first_name\": \"Test Subscriber 0\",\n \"email_address\": \"subscriber_0@convertkit.dev\"\n },\n {\n \"first_name\": \"Test Subscriber 1\",\n \"email_address\": \"subscriber_1@convertkit.dev\"\n },\n {\n \"first_name\": \"Test Subscriber 2\",\n \"email_address\": \"subscriber_2@convertkit.dev\"\n },\n {\n \"first_name\": \"Test Subscriber 3\",\n \"email_address\": \"subscriber_3@convertkit.dev\"\n }\n ],\n \"callback_url\": null\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kit.com/v4/bulk/subscribers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'subscribers' => [
[
'first_name' => 'Test Subscriber 0',
'email_address' => 'subscriber_0@convertkit.dev'
],
[
'first_name' => 'Test Subscriber 1',
'email_address' => 'subscriber_1@convertkit.dev'
],
[
'first_name' => 'Test Subscriber 2',
'email_address' => 'subscriber_2@convertkit.dev'
],
[
'first_name' => 'Test Subscriber 3',
'email_address' => 'subscriber_3@convertkit.dev'
]
],
'callback_url' => null
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://api.kit.com/v4/bulk/subscribers"
payload = {
"subscribers": [
{
"first_name": "Test Subscriber 0",
"email_address": "subscriber_0@convertkit.dev"
},
{
"first_name": "Test Subscriber 1",
"email_address": "subscriber_1@convertkit.dev"
},
{
"first_name": "Test Subscriber 2",
"email_address": "subscriber_2@convertkit.dev"
},
{
"first_name": "Test Subscriber 3",
"email_address": "subscriber_3@convertkit.dev"
}
],
"callback_url": None
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"subscribers": [
{
"id": 596,
"first_name": null,
"email_address": "brooke@convertkit.dev",
"state": "active",
"created_at": "2023-02-17T11:43:55Z"
},
{
"id": 597,
"first_name": "Camille",
"email_address": "camille@convertkit.dev",
"state": "active",
"created_at": "2023-02-17T11:43:55Z"
},
{
"id": 595,
"first_name": "Alice",
"email_address": "alice@convertkit.dev",
"state": "active",
"created_at": "2023-02-17T11:43:55Z"
}
],
"failures": [
{
"subscriber": {
"first_name": "Benito",
"email_address": null,
"state": "active",
"created_at": null
},
"errors": [
"Email address is invalid"
]
}
]
}{}{
"errors": [
"The access token is invalid"
]
}{
"errors": [
"This request would exceed your subscriber limit"
]
}{
"errors": [
"This request exceeds your queued bulk requests limit. Please wait while we process your existing requests and try again later."
]
}{
"errors": [
"No subscribers included for processing"
]
}Authorizations
Authenticate API requests via an OAuth token
Was this page helpful?
⌘I