Skip to main content
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",
      "apt": "",
      "city": "Anytown",
      "state": "CA",
      "zip": "12345",
      "country": "United States",
      "email": "[email protected]",
      "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"
    }
  ]
}
'
{
  "data": {
    "message": "<string>",
    "contacts_updated": 123,
    "contacts_created": 123
  }
}

​
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

​
Example: Adding Recipients with Custom Messages

{
  "recipients": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "address": "123 Main St",
      "apt": "",
      "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"
    }
  ]
}

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

Response

Recipients added successfully

​
data
object