Add Recipients

Add recipients to a project

curl --request POST \
  --url https://www.postable.com/api/v1/projects/add-recipients/{projectUuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipients": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "address": "123 Main St",
      "city": "Anytown",
      "state": "CA",
      "zip": "12345",
      "country": "United States",
      "email": "john@example.com",
      "internal_id": "CUST-001"
    },
    {
      "first_name": "Jane",
      "last_name": "Smith",
      "address": "456 Oak Ave",
      "apt": "Suite 100",
      "city": "Othertown",
      "state": "NY",
      "zip": "67890",
      "country": "United States",
      "override_message": "Custom message for Jane"
    }
  ]
}
'

import requests

url = "https://www.postable.com/api/v1/projects/add-recipients/{projectUuid}"

payload = { "recipients": [
        {
            "first_name": "John",
            "last_name": "Doe",
            "address": "123 Main St",
            "city": "Anytown",
            "state": "CA",
            "zip": "12345",
            "country": "United States",
            "email": "john@example.com",
            "internal_id": "CUST-001"
        },
        {
            "first_name": "Jane",
            "last_name": "Smith",
            "address": "456 Oak Ave",
            "apt": "Suite 100",
            "city": "Othertown",
            "state": "NY",
            "zip": "67890",
            "country": "United States",
            "override_message": "Custom message for Jane"
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    recipients: [
      {
        first_name: 'John',
        last_name: 'Doe',
        address: '123 Main St',
        city: 'Anytown',
        state: 'CA',
        zip: '12345',
        country: 'United States',
        email: 'john@example.com',
        internal_id: 'CUST-001'
      },
      {
        first_name: 'Jane',
        last_name: 'Smith',
        address: '456 Oak Ave',
        apt: 'Suite 100',
        city: 'Othertown',
        state: 'NY',
        zip: '67890',
        country: 'United States',
        override_message: 'Custom message for Jane'
      }
    ]
  })
};

fetch('https://www.postable.com/api/v1/projects/add-recipients/{projectUuid}', 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://www.postable.com/api/v1/projects/add-recipients/{projectUuid}",
  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([
    'recipients' => [
        [
                'first_name' => 'John',
                'last_name' => 'Doe',
                'address' => '123 Main St',
                'city' => 'Anytown',
                'state' => 'CA',
                'zip' => '12345',
                'country' => 'United States',
                'email' => 'john@example.com',
                'internal_id' => 'CUST-001'
        ],
        [
                'first_name' => 'Jane',
                'last_name' => 'Smith',
                'address' => '456 Oak Ave',
                'apt' => 'Suite 100',
                'city' => 'Othertown',
                'state' => 'NY',
                'zip' => '67890',
                'country' => 'United States',
                'override_message' => 'Custom message for Jane'
        ]
    ]
  ]),
  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;
}

package main

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

func main() {

	url := "https://www.postable.com/api/v1/projects/add-recipients/{projectUuid}"

	payload := strings.NewReader("{\n  \"recipients\": [\n    {\n      \"first_name\": \"John\",\n      \"last_name\": \"Doe\",\n      \"address\": \"123 Main St\",\n      \"city\": \"Anytown\",\n      \"state\": \"CA\",\n      \"zip\": \"12345\",\n      \"country\": \"United States\",\n      \"email\": \"john@example.com\",\n      \"internal_id\": \"CUST-001\"\n    },\n    {\n      \"first_name\": \"Jane\",\n      \"last_name\": \"Smith\",\n      \"address\": \"456 Oak Ave\",\n      \"apt\": \"Suite 100\",\n      \"city\": \"Othertown\",\n      \"state\": \"NY\",\n      \"zip\": \"67890\",\n      \"country\": \"United States\",\n      \"override_message\": \"Custom message for Jane\"\n    }\n  ]\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))

}

HttpResponse<String> response = Unirest.post("https://www.postable.com/api/v1/projects/add-recipients/{projectUuid}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recipients\": [\n    {\n      \"first_name\": \"John\",\n      \"last_name\": \"Doe\",\n      \"address\": \"123 Main St\",\n      \"city\": \"Anytown\",\n      \"state\": \"CA\",\n      \"zip\": \"12345\",\n      \"country\": \"United States\",\n      \"email\": \"john@example.com\",\n      \"internal_id\": \"CUST-001\"\n    },\n    {\n      \"first_name\": \"Jane\",\n      \"last_name\": \"Smith\",\n      \"address\": \"456 Oak Ave\",\n      \"apt\": \"Suite 100\",\n      \"city\": \"Othertown\",\n      \"state\": \"NY\",\n      \"zip\": \"67890\",\n      \"country\": \"United States\",\n      \"override_message\": \"Custom message for Jane\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.postable.com/api/v1/projects/add-recipients/{projectUuid}")

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  \"recipients\": [\n    {\n      \"first_name\": \"John\",\n      \"last_name\": \"Doe\",\n      \"address\": \"123 Main St\",\n      \"city\": \"Anytown\",\n      \"state\": \"CA\",\n      \"zip\": \"12345\",\n      \"country\": \"United States\",\n      \"email\": \"john@example.com\",\n      \"internal_id\": \"CUST-001\"\n    },\n    {\n      \"first_name\": \"Jane\",\n      \"last_name\": \"Smith\",\n      \"address\": \"456 Oak Ave\",\n      \"apt\": \"Suite 100\",\n      \"city\": \"Othertown\",\n      \"state\": \"NY\",\n      \"zip\": \"67890\",\n      \"country\": \"United States\",\n      \"override_message\": \"Custom message for Jane\"\n    }\n  ]\n}"

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

{
  "data": {
    "message": "<string>",
    "contacts_updated": 123,
    "contacts_created": 123
  }
}

{
  "message": "You do not have permission to update this project"
}

{
  "message": "Project not found"
}

POST

projects

add-recipients

{projectUuid}

Add recipients to a project

curl --request POST \
  --url https://www.postable.com/api/v1/projects/add-recipients/{projectUuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipients": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "address": "123 Main St",
      "city": "Anytown",
      "state": "CA",
      "zip": "12345",
      "country": "United States",
      "email": "john@example.com",
      "internal_id": "CUST-001"
    },
    {
      "first_name": "Jane",
      "last_name": "Smith",
      "address": "456 Oak Ave",
      "apt": "Suite 100",
      "city": "Othertown",
      "state": "NY",
      "zip": "67890",
      "country": "United States",
      "override_message": "Custom message for Jane"
    }
  ]
}
'

import requests

url = "https://www.postable.com/api/v1/projects/add-recipients/{projectUuid}"

payload = { "recipients": [
        {
            "first_name": "John",
            "last_name": "Doe",
            "address": "123 Main St",
            "city": "Anytown",
            "state": "CA",
            "zip": "12345",
            "country": "United States",
            "email": "john@example.com",
            "internal_id": "CUST-001"
        },
        {
            "first_name": "Jane",
            "last_name": "Smith",
            "address": "456 Oak Ave",
            "apt": "Suite 100",
            "city": "Othertown",
            "state": "NY",
            "zip": "67890",
            "country": "United States",
            "override_message": "Custom message for Jane"
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    recipients: [
      {
        first_name: 'John',
        last_name: 'Doe',
        address: '123 Main St',
        city: 'Anytown',
        state: 'CA',
        zip: '12345',
        country: 'United States',
        email: 'john@example.com',
        internal_id: 'CUST-001'
      },
      {
        first_name: 'Jane',
        last_name: 'Smith',
        address: '456 Oak Ave',
        apt: 'Suite 100',
        city: 'Othertown',
        state: 'NY',
        zip: '67890',
        country: 'United States',
        override_message: 'Custom message for Jane'
      }
    ]
  })
};

fetch('https://www.postable.com/api/v1/projects/add-recipients/{projectUuid}', 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://www.postable.com/api/v1/projects/add-recipients/{projectUuid}",
  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([
    'recipients' => [
        [
                'first_name' => 'John',
                'last_name' => 'Doe',
                'address' => '123 Main St',
                'city' => 'Anytown',
                'state' => 'CA',
                'zip' => '12345',
                'country' => 'United States',
                'email' => 'john@example.com',
                'internal_id' => 'CUST-001'
        ],
        [
                'first_name' => 'Jane',
                'last_name' => 'Smith',
                'address' => '456 Oak Ave',
                'apt' => 'Suite 100',
                'city' => 'Othertown',
                'state' => 'NY',
                'zip' => '67890',
                'country' => 'United States',
                'override_message' => 'Custom message for Jane'
        ]
    ]
  ]),
  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;
}

package main

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

func main() {

	url := "https://www.postable.com/api/v1/projects/add-recipients/{projectUuid}"

	payload := strings.NewReader("{\n  \"recipients\": [\n    {\n      \"first_name\": \"John\",\n      \"last_name\": \"Doe\",\n      \"address\": \"123 Main St\",\n      \"city\": \"Anytown\",\n      \"state\": \"CA\",\n      \"zip\": \"12345\",\n      \"country\": \"United States\",\n      \"email\": \"john@example.com\",\n      \"internal_id\": \"CUST-001\"\n    },\n    {\n      \"first_name\": \"Jane\",\n      \"last_name\": \"Smith\",\n      \"address\": \"456 Oak Ave\",\n      \"apt\": \"Suite 100\",\n      \"city\": \"Othertown\",\n      \"state\": \"NY\",\n      \"zip\": \"67890\",\n      \"country\": \"United States\",\n      \"override_message\": \"Custom message for Jane\"\n    }\n  ]\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))

}

HttpResponse<String> response = Unirest.post("https://www.postable.com/api/v1/projects/add-recipients/{projectUuid}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recipients\": [\n    {\n      \"first_name\": \"John\",\n      \"last_name\": \"Doe\",\n      \"address\": \"123 Main St\",\n      \"city\": \"Anytown\",\n      \"state\": \"CA\",\n      \"zip\": \"12345\",\n      \"country\": \"United States\",\n      \"email\": \"john@example.com\",\n      \"internal_id\": \"CUST-001\"\n    },\n    {\n      \"first_name\": \"Jane\",\n      \"last_name\": \"Smith\",\n      \"address\": \"456 Oak Ave\",\n      \"apt\": \"Suite 100\",\n      \"city\": \"Othertown\",\n      \"state\": \"NY\",\n      \"zip\": \"67890\",\n      \"country\": \"United States\",\n      \"override_message\": \"Custom message for Jane\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.postable.com/api/v1/projects/add-recipients/{projectUuid}")

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  \"recipients\": [\n    {\n      \"first_name\": \"John\",\n      \"last_name\": \"Doe\",\n      \"address\": \"123 Main St\",\n      \"city\": \"Anytown\",\n      \"state\": \"CA\",\n      \"zip\": \"12345\",\n      \"country\": \"United States\",\n      \"email\": \"john@example.com\",\n      \"internal_id\": \"CUST-001\"\n    },\n    {\n      \"first_name\": \"Jane\",\n      \"last_name\": \"Smith\",\n      \"address\": \"456 Oak Ave\",\n      \"apt\": \"Suite 100\",\n      \"city\": \"Othertown\",\n      \"state\": \"NY\",\n      \"zip\": \"67890\",\n      \"country\": \"United States\",\n      \"override_message\": \"Custom message for Jane\"\n    }\n  ]\n}"

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

{
  "data": {
    "message": "<string>",
    "contacts_updated": 123,
    "contacts_created": 123
  }
}

{
  "message": "You do not have permission to update this project"
}

{
  "message": "Project not found"
}

Overview

Add one or more recipients to an existing project. Each recipient will be created as a contact in your address book and added to the project.

Behavior

If a recipient has an internal_id that matches an existing contact, that contact will be updated instead of creating a duplicate
Recipients without internal_id will always create new contacts
Use override_message and override_signoff to customize the card message for specific recipients
Use sender to set a per-recipient return address. When provided, the printed card shows this sender in the corner instead of your account-level return address. Omit it to use the account default.

Per-Recipient Sender (Return Address)

By default, every card prints your account’s return address in the corner. To make each card show its own individual sender, include a sender object on the recipient.

If sender is present, address, city, and country are required, and either name or company must be provided.
For United States addresses, state and a valid zip are also required.
Recipients without a sender continue to use the account-level return address.

Example: Adding Recipients with Custom Messages

{
  "recipients": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "address": "123 Main St",
      "city": "Anytown",
      "state": "CA",
      "zip": "12345",
      "country": "United States",
      "internal_id": "CUST-001"
    },
    {
      "first_name": "Jane",
      "last_name": "Smith",
      "address": "456 Oak Ave",
      "apt": "Suite 100",
      "city": "Othertown",
      "state": "NY",
      "zip": "67890",
      "country": "United States",
      "override_message": "Dear Jane, wishing you a wonderful holiday season!",
      "override_signoff": "Best wishes, The Team"
    }
  ]
}

Example: Adding a Recipient with a Custom Sender

{
  "recipients": [
    {
      "first_name": "Jane",
      "last_name": "Smith",
      "address": "456 Oak Ave",
      "city": "Othertown",
      "state": "NY",
      "zip": "67890",
      "country": "United States",
      "sender": {
        "name": "Alex Rivera",
        "company": "",
        "address": "789 Sender St",
        "apt": "Unit 4",
        "city": "Portland",
        "state": "OR",
        "zip": "97201",
        "country": "United States"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

projectUuid

string<uuid>

required

UUID of the project to add recipients to

Body

application/json

recipients

object[]

required

Show child attributes

Response

Recipients added successfully

data

object

Show child attributes

List Projects Checkout Project

Getting Started

API Reference

Overview

Behavior

Per-Recipient Sender (Return Address)

Example: Adding Recipients with Custom Messages

Example: Adding a Recipient with a Custom Sender

Authorizations

Path Parameters

Body

Response

​Overview

​Behavior

​Per-Recipient Sender (Return Address)

​Example: Adding Recipients with Custom Messages

​Example: Adding a Recipient with a Custom Sender

Authorizations

Path Parameters

Body

Response

Overview

Behavior

Per-Recipient Sender (Return Address)

Example: Adding Recipients with Custom Messages

Example: Adding a Recipient with a Custom Sender