Skip to main content
POST
/
contacts
Create a new contact
curl --request POST \
  --url https://www.postable.com/api/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "prefix": "Mr.",
  "first_name": "John",
  "middle_name": "Robert",
  "last_name": "Doe",
  "company": "Acme Inc.",
  "email": "john.doe@example.com",
  "phone": "555-123-4567",
  "address": "123 Main St",
  "apt": "Apt 4B",
  "city": "Anytown",
  "state": "CA",
  "zip": "12345",
  "country": "United States",
  "spouse_prefix": "Mrs.",
  "spouse_first_name": "Jane",
  "spouse_middle_name": "Marie",
  "spouse_last_name": "Doe",
  "birth_month": 5,
  "birth_day": 15,
  "birth_year": 1980,
  "anniversary_month": 6,
  "anniversary_day": 20,
  "anniversary_year": 2010,
  "spouse_birth_month": 8,
  "spouse_birth_day": 25,
  "spouse_birth_year": 1982,
  "children": [
    {
      "first_name": "Jimmy",
      "birth_month": 3,
      "birth_day": 12,
      "birth_year": 2012
    },
    {
      "first_name": "Sally",
      "birth_month": 9,
      "birth_day": 8,
      "birth_year": 2015
    }
  ],
  "pets": [
    {
      "name": "Fido",
      "birth_month": 4,
      "birth_day": 10,
      "birth_year": 2018,
      "secondary_type": "Dog"
    }
  ],
  "notes": "This is a test contact."
}'
{
  "data": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "prefix": "<string>",
    "first_name": "<string>",
    "middle_name": "<string>",
    "last_name": "<string>",
    "company": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "address": "<string>",
    "apt": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>",
    "spouse_prefix": "<string>",
    "spouse_first_name": "<string>",
    "spouse_middle_name": "<string>",
    "spouse_last_name": "<string>",
    "birth_month": 6,
    "birth_day": 16,
    "birth_year": 123,
    "anniversary_month": 6,
    "anniversary_day": 16,
    "anniversary_year": 123,
    "spouse_birth_month": 6,
    "spouse_birth_day": 16,
    "spouse_birth_year": 123,
    "children": [
      {
        "first_name": "<string>",
        "birth_month": 6,
        "birth_day": 16,
        "birth_year": 123
      }
    ],
    "pets": [
      {
        "name": "<string>",
        "birth_month": 6,
        "birth_day": 16,
        "birth_year": 123,
        "secondary_type": "<string>"
      }
    ],
    "notes": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json
first_name
string
required

First name of the contact

last_name
string
required

Last name of the contact

uuid
string<uuid>

Unique identifier for the contact

prefix
string

Prefix/title (e.g., Mr., Mrs., Dr.)

middle_name
string

Middle name of the contact

company
string

Company name

email
string<email>

Email address

phone
string

Phone number

address
string

Street address

apt
string

Apartment, suite, or unit number

city
string

City

state
string

State or province

zip
string

ZIP or postal code

country
string

Country

spouse_prefix
string

Spouse's prefix/title

spouse_first_name
string

Spouse's first name

spouse_middle_name
string

Spouse's middle name

spouse_last_name
string

Spouse's last name

birth_month
integer

Birth month

Required range: 1 <= x <= 12
birth_day
integer

Birth day

Required range: 1 <= x <= 31
birth_year
integer

Birth year

anniversary_month
integer

Anniversary month

Required range: 1 <= x <= 12
anniversary_day
integer

Anniversary day

Required range: 1 <= x <= 31
anniversary_year
integer

Anniversary year

spouse_birth_month
integer

Spouse's birth month

Required range: 1 <= x <= 12
spouse_birth_day
integer

Spouse's birth day

Required range: 1 <= x <= 31
spouse_birth_year
integer

Spouse's birth year

children
object[]

List of children

pets
object[]

List of pets

notes
string

Additional notes about the contact

created_at
string<date-time>

Creation timestamp in ISO-8601 format

updated_at
string<date-time>

Last update timestamp in ISO-8601 format

Response

201 - application/json

Contact created successfully

data
object
I