Bulk create subscribers

curl --request POST \
  --url https://api.paubox.com/v1/marketing/subscribers_bulk_create \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "subscribers": [
    {
      "email": "jsmith@example.com",
      "first_name": "<string>",
      "last_name": "<string>",
      "custom_fields": [
        {}
      ]
    }
  ],
  "subscription_list_id": "<string>"
}
'

import requests

url = "https://api.paubox.com/v1/marketing/subscribers_bulk_create"

payload = {
    "subscribers": [
        {
            "email": "jsmith@example.com",
            "first_name": "<string>",
            "last_name": "<string>",
            "custom_fields": [{}]
        }
    ],
    "subscription_list_id": "<string>"
}
headers = {
    "authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    subscribers: [
      {
        email: 'jsmith@example.com',
        first_name: '<string>',
        last_name: '<string>',
        custom_fields: [{}]
      }
    ],
    subscription_list_id: '<string>'
  })
};

fetch('https://api.paubox.com/v1/marketing/subscribers_bulk_create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paubox.com/v1/marketing/subscribers_bulk_create",
  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' => [
        [
                'email' => 'jsmith@example.com',
                'first_name' => '<string>',
                'last_name' => '<string>',
                'custom_fields' => [
                                [
                                                                
                                ]
                ]
        ]
    ],
    'subscription_list_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paubox.com/v1/marketing/subscribers_bulk_create"

	payload := strings.NewReader("{\n  \"subscribers\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"first_name\": \"<string>\",\n      \"last_name\": \"<string>\",\n      \"custom_fields\": [\n        {}\n      ]\n    }\n  ],\n  \"subscription_list_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("authorization", "<api-key>")
	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))

}

HttpResponse<String> response = Unirest.post("https://api.paubox.com/v1/marketing/subscribers_bulk_create")
  .header("authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subscribers\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"first_name\": \"<string>\",\n      \"last_name\": \"<string>\",\n      \"custom_fields\": [\n        {}\n      ]\n    }\n  ],\n  \"subscription_list_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paubox.com/v1/marketing/subscribers_bulk_create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"subscribers\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"first_name\": \"<string>\",\n      \"last_name\": \"<string>\",\n      \"custom_fields\": [\n        {}\n      ]\n    }\n  ],\n  \"subscription_list_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "num_subscribers_added": 123
  }
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

POST

subscribers_bulk_create

Bulk create subscribers

curl --request POST \
  --url https://api.paubox.com/v1/marketing/subscribers_bulk_create \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "subscribers": [
    {
      "email": "jsmith@example.com",
      "first_name": "<string>",
      "last_name": "<string>",
      "custom_fields": [
        {}
      ]
    }
  ],
  "subscription_list_id": "<string>"
}
'

import requests

url = "https://api.paubox.com/v1/marketing/subscribers_bulk_create"

payload = {
    "subscribers": [
        {
            "email": "jsmith@example.com",
            "first_name": "<string>",
            "last_name": "<string>",
            "custom_fields": [{}]
        }
    ],
    "subscription_list_id": "<string>"
}
headers = {
    "authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    subscribers: [
      {
        email: 'jsmith@example.com',
        first_name: '<string>',
        last_name: '<string>',
        custom_fields: [{}]
      }
    ],
    subscription_list_id: '<string>'
  })
};

fetch('https://api.paubox.com/v1/marketing/subscribers_bulk_create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paubox.com/v1/marketing/subscribers_bulk_create",
  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' => [
        [
                'email' => 'jsmith@example.com',
                'first_name' => '<string>',
                'last_name' => '<string>',
                'custom_fields' => [
                                [
                                                                
                                ]
                ]
        ]
    ],
    'subscription_list_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paubox.com/v1/marketing/subscribers_bulk_create"

	payload := strings.NewReader("{\n  \"subscribers\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"first_name\": \"<string>\",\n      \"last_name\": \"<string>\",\n      \"custom_fields\": [\n        {}\n      ]\n    }\n  ],\n  \"subscription_list_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("authorization", "<api-key>")
	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))

}

HttpResponse<String> response = Unirest.post("https://api.paubox.com/v1/marketing/subscribers_bulk_create")
  .header("authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subscribers\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"first_name\": \"<string>\",\n      \"last_name\": \"<string>\",\n      \"custom_fields\": [\n        {}\n      ]\n    }\n  ],\n  \"subscription_list_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paubox.com/v1/marketing/subscribers_bulk_create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"subscribers\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"first_name\": \"<string>\",\n      \"last_name\": \"<string>\",\n      \"custom_fields\": [\n        {}\n      ]\n    }\n  ],\n  \"subscription_list_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "num_subscribers_added": 123
  }
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "details": {}
}

Authorizations

authorization

string

header

required

Token-based authentication. Use format: "Token token=<API_KEY>" where <API_KEY> is your API key

Body

application/json

subscribers

object[]

Array of subscribers to create

Show child attributes

subscription_list_id

string

Optional subscription list ID

Response

Subscribers created successfully

data

object

Show child attributes

⌘I

Email API · Messages

Email API · Dynamic templates

Marketing · Campaigns

Marketing · Drip campaigns

Marketing · Subscribers

Marketing · Subscription lists

Marketing · Tracking links

Marketing · Analytics

Forms API

Bulk create subscribers

Authorizations

Body

Response