curl --request POST \
--url https://api.kit.com/v4/bulk/custom_fields/subscribers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"custom_field_values": [
{
"subscriber_id": 0,
"subscriber_custom_field_id": 0,
"value": "value_0"
},
{
"subscriber_id": 1,
"subscriber_custom_field_id": 1,
"value": "value_1"
},
{
"subscriber_id": 2,
"subscriber_custom_field_id": 2,
"value": "value_2"
},
{
"subscriber_id": 3,
"subscriber_custom_field_id": 3,
"value": "value_3"
}
],
"callback_url": null
}
'require 'uri'
require 'net/http'
url = URI("https://api.kit.com/v4/bulk/custom_fields/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 \"custom_field_values\": [\n {\n \"subscriber_id\": 0,\n \"subscriber_custom_field_id\": 0,\n \"value\": \"value_0\"\n },\n {\n \"subscriber_id\": 1,\n \"subscriber_custom_field_id\": 1,\n \"value\": \"value_1\"\n },\n {\n \"subscriber_id\": 2,\n \"subscriber_custom_field_id\": 2,\n \"value\": \"value_2\"\n },\n {\n \"subscriber_id\": 3,\n \"subscriber_custom_field_id\": 3,\n \"value\": \"value_3\"\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({
custom_field_values: [
{subscriber_id: 0, subscriber_custom_field_id: 0, value: 'value_0'},
{subscriber_id: 1, subscriber_custom_field_id: 1, value: 'value_1'},
{subscriber_id: 2, subscriber_custom_field_id: 2, value: 'value_2'},
{subscriber_id: 3, subscriber_custom_field_id: 3, value: 'value_3'}
],
callback_url: null
})
};
fetch('https://api.kit.com/v4/bulk/custom_fields/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/custom_fields/subscribers"
payload := strings.NewReader("{\n \"custom_field_values\": [\n {\n \"subscriber_id\": 0,\n \"subscriber_custom_field_id\": 0,\n \"value\": \"value_0\"\n },\n {\n \"subscriber_id\": 1,\n \"subscriber_custom_field_id\": 1,\n \"value\": \"value_1\"\n },\n {\n \"subscriber_id\": 2,\n \"subscriber_custom_field_id\": 2,\n \"value\": \"value_2\"\n },\n {\n \"subscriber_id\": 3,\n \"subscriber_custom_field_id\": 3,\n \"value\": \"value_3\"\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/custom_fields/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([
'custom_field_values' => [
[
'subscriber_id' => 0,
'subscriber_custom_field_id' => 0,
'value' => 'value_0'
],
[
'subscriber_id' => 1,
'subscriber_custom_field_id' => 1,
'value' => 'value_1'
],
[
'subscriber_id' => 2,
'subscriber_custom_field_id' => 2,
'value' => 'value_2'
],
[
'subscriber_id' => 3,
'subscriber_custom_field_id' => 3,
'value' => 'value_3'
]
],
'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/custom_fields/subscribers"
payload = {
"custom_field_values": [
{
"subscriber_id": 0,
"subscriber_custom_field_id": 0,
"value": "value_0"
},
{
"subscriber_id": 1,
"subscriber_custom_field_id": 1,
"value": "value_1"
},
{
"subscriber_id": 2,
"subscriber_custom_field_id": 2,
"value": "value_2"
},
{
"subscriber_id": 3,
"subscriber_custom_field_id": 3,
"value": "value_3"
}
],
"callback_url": None
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"custom_field_values": [
{
"subscriber_id": 615,
"subscriber_custom_field_id": 156,
"value": "Smith"
},
{
"subscriber_id": 615,
"subscriber_custom_field_id": 157,
"value": "Acme Inc"
}
],
"failures": [
{
"errors": [
"Subscriber does not exist"
],
"custom_field_value": {
"subscriber_id": null,
"subscriber_custom_field_id": 156,
"value": "Jones"
}
},
{
"errors": [
"Custom field does not exist"
],
"custom_field_value": {
"subscriber_id": 615,
"subscriber_custom_field_id": 999999,
"value": "Test"
}
}
]
}{}{
"errors": [
"The access token is invalid"
]
}{
"errors": [
"This request exceeds your queued bulk requests limit. Please wait while we process your existing requests and try again later."
]
}{
"errors": [
"No custom field values included for processing"
]
}Bulk update subscriber custom field values
Creates or updates custom field values for many subscribers in one request. Each entry in custom_field_values pairs a subscriber_id with a subscriber_custom_field_id and the value to set. Requires OAuth authentication.
Requests with 100 or fewer values are processed synchronously (200); larger requests are processed asynchronously (202) — provide a callback_url to be notified on completion, and see Bulk & async processing for how async requests behave. Returns 413 when the request would exceed the account’s data limit for enqueued bulk requests.
The custom fields must already exist — entries referencing an unknown subscriber_custom_field_id are rejected individually with a Custom field does not exist error in the response’s failures list, while the rest of the batch is still processed. See List custom fields and Bulk create custom fields.
curl --request POST \
--url https://api.kit.com/v4/bulk/custom_fields/subscribers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"custom_field_values": [
{
"subscriber_id": 0,
"subscriber_custom_field_id": 0,
"value": "value_0"
},
{
"subscriber_id": 1,
"subscriber_custom_field_id": 1,
"value": "value_1"
},
{
"subscriber_id": 2,
"subscriber_custom_field_id": 2,
"value": "value_2"
},
{
"subscriber_id": 3,
"subscriber_custom_field_id": 3,
"value": "value_3"
}
],
"callback_url": null
}
'require 'uri'
require 'net/http'
url = URI("https://api.kit.com/v4/bulk/custom_fields/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 \"custom_field_values\": [\n {\n \"subscriber_id\": 0,\n \"subscriber_custom_field_id\": 0,\n \"value\": \"value_0\"\n },\n {\n \"subscriber_id\": 1,\n \"subscriber_custom_field_id\": 1,\n \"value\": \"value_1\"\n },\n {\n \"subscriber_id\": 2,\n \"subscriber_custom_field_id\": 2,\n \"value\": \"value_2\"\n },\n {\n \"subscriber_id\": 3,\n \"subscriber_custom_field_id\": 3,\n \"value\": \"value_3\"\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({
custom_field_values: [
{subscriber_id: 0, subscriber_custom_field_id: 0, value: 'value_0'},
{subscriber_id: 1, subscriber_custom_field_id: 1, value: 'value_1'},
{subscriber_id: 2, subscriber_custom_field_id: 2, value: 'value_2'},
{subscriber_id: 3, subscriber_custom_field_id: 3, value: 'value_3'}
],
callback_url: null
})
};
fetch('https://api.kit.com/v4/bulk/custom_fields/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/custom_fields/subscribers"
payload := strings.NewReader("{\n \"custom_field_values\": [\n {\n \"subscriber_id\": 0,\n \"subscriber_custom_field_id\": 0,\n \"value\": \"value_0\"\n },\n {\n \"subscriber_id\": 1,\n \"subscriber_custom_field_id\": 1,\n \"value\": \"value_1\"\n },\n {\n \"subscriber_id\": 2,\n \"subscriber_custom_field_id\": 2,\n \"value\": \"value_2\"\n },\n {\n \"subscriber_id\": 3,\n \"subscriber_custom_field_id\": 3,\n \"value\": \"value_3\"\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/custom_fields/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([
'custom_field_values' => [
[
'subscriber_id' => 0,
'subscriber_custom_field_id' => 0,
'value' => 'value_0'
],
[
'subscriber_id' => 1,
'subscriber_custom_field_id' => 1,
'value' => 'value_1'
],
[
'subscriber_id' => 2,
'subscriber_custom_field_id' => 2,
'value' => 'value_2'
],
[
'subscriber_id' => 3,
'subscriber_custom_field_id' => 3,
'value' => 'value_3'
]
],
'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/custom_fields/subscribers"
payload = {
"custom_field_values": [
{
"subscriber_id": 0,
"subscriber_custom_field_id": 0,
"value": "value_0"
},
{
"subscriber_id": 1,
"subscriber_custom_field_id": 1,
"value": "value_1"
},
{
"subscriber_id": 2,
"subscriber_custom_field_id": 2,
"value": "value_2"
},
{
"subscriber_id": 3,
"subscriber_custom_field_id": 3,
"value": "value_3"
}
],
"callback_url": None
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"custom_field_values": [
{
"subscriber_id": 615,
"subscriber_custom_field_id": 156,
"value": "Smith"
},
{
"subscriber_id": 615,
"subscriber_custom_field_id": 157,
"value": "Acme Inc"
}
],
"failures": [
{
"errors": [
"Subscriber does not exist"
],
"custom_field_value": {
"subscriber_id": null,
"subscriber_custom_field_id": 156,
"value": "Jones"
}
},
{
"errors": [
"Custom field does not exist"
],
"custom_field_value": {
"subscriber_id": 615,
"subscriber_custom_field_id": 999999,
"value": "Test"
}
}
]
}{}{
"errors": [
"The access token is invalid"
]
}{
"errors": [
"This request exceeds your queued bulk requests limit. Please wait while we process your existing requests and try again later."
]
}{
"errors": [
"No custom field values included for processing"
]
}Authorizations
Authenticate API requests via an OAuth token
Body
Was this page helpful?