Getting started
Guides
Endpoints
- Accounts
- Broadcasts
- Custom Fields
- Forms
- Subscribers
- Tags
- Email Templates
- Purchases
- Segments
- Sequences
- Webhooks
Forms
Bulk add subscribers to forms
Adding subscribers to double opt-in forms will trigger sending an Incentive Email. Subscribers already added to the specified form will not receive the Incentive Email again. For more information about double opt-in see “Double opt-in”.
The subscribers being added to the form must already exist. Subscribers can be created in bulk using the “Bulk create subscriber” endpoint.
See “Bulk & async processing” for more information.
POST
/
v4
/
bulk
/
forms
/
subscribers
Copy
Ask AI
curl --request POST \
--url https://api.kit.com/v4/bulk/forms/subscribers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"additions": [
{
"form_id": 0,
"subscriber_id": 0
},
{
"form_id": 1,
"subscriber_id": 1
},
{
"form_id": 2,
"subscriber_id": 2
},
{
"form_id": 3,
"subscriber_id": 3
}
],
"callback_url": null
}'
Copy
Ask AI
{
"subscribers": [
{
"id": 15945,
"first_name": "Sub",
"email_address": "[email protected]",
"created_at": "2023-02-17T11:43:55Z",
"added_at": "2023-02-17T11:43:55Z",
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off",
"referrer_utm_parameters": {
"source": "facebook",
"medium": "cpc",
"campaign": "black_friday",
"term": "car_owners",
"content": "get_10_off"
}
},
{
"id": 15945,
"first_name": "Sub",
"email_address": "[email protected]",
"created_at": "2023-02-17T11:43:55Z",
"added_at": "2023-02-17T11:43:55Z",
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off",
"referrer_utm_parameters": {
"source": "facebook",
"medium": "cpc",
"campaign": "black_friday",
"term": "car_owners",
"content": "get_10_off"
}
}
],
"failures": [
{
"errors": [
"Subscriber does not exist"
],
"subscription": {
"form_id": 3270,
"subscriber_id": null,
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off"
}
},
{
"errors": [
"Form does not exist"
],
"subscription": {
"form_id": null,
"subscriber_id": 15945,
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off"
}
}
]
}
Authorizations
Authenticate API requests via an OAuth token
Body
application/json
Response
200
application/json
Adds subscribers to forms synchronously when 100 or less form/subscribers are requested
The response is of type object
.
Copy
Ask AI
curl --request POST \
--url https://api.kit.com/v4/bulk/forms/subscribers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"additions": [
{
"form_id": 0,
"subscriber_id": 0
},
{
"form_id": 1,
"subscriber_id": 1
},
{
"form_id": 2,
"subscriber_id": 2
},
{
"form_id": 3,
"subscriber_id": 3
}
],
"callback_url": null
}'
Copy
Ask AI
{
"subscribers": [
{
"id": 15945,
"first_name": "Sub",
"email_address": "[email protected]",
"created_at": "2023-02-17T11:43:55Z",
"added_at": "2023-02-17T11:43:55Z",
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off",
"referrer_utm_parameters": {
"source": "facebook",
"medium": "cpc",
"campaign": "black_friday",
"term": "car_owners",
"content": "get_10_off"
}
},
{
"id": 15945,
"first_name": "Sub",
"email_address": "[email protected]",
"created_at": "2023-02-17T11:43:55Z",
"added_at": "2023-02-17T11:43:55Z",
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off",
"referrer_utm_parameters": {
"source": "facebook",
"medium": "cpc",
"campaign": "black_friday",
"term": "car_owners",
"content": "get_10_off"
}
}
],
"failures": [
{
"errors": [
"Subscriber does not exist"
],
"subscription": {
"form_id": 3270,
"subscriber_id": null,
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off"
}
},
{
"errors": [
"Form does not exist"
],
"subscription": {
"form_id": null,
"subscriber_id": 15945,
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off"
}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.