Skip to main content
POST
/
v1
/
contacts
Create a contact
curl --request POST \
  --url https://api.slant.app/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "book_id": "abc123xyz",
  "first_name": "John",
  "last_name": "Doe",
  "middle_name": "Robert",
  "preferred_name": "Johnny",
  "salutation": "Mr.",
  "suffix": "Jr.",
  "gender": "male",
  "designations": "CPA, CFP",
  "email_addresses": [
    {
      "email": "john@example.com",
      "email_type": "personal",
      "is_primary": true
    }
  ],
  "phone_numbers": [
    {
      "phone_number": "+15555551234",
      "phone_type": "mobile",
      "is_primary": true
    }
  ],
  "addresses": [
    {
      "line1": "123 Main St",
      "line2": "Apt 4B",
      "city": "New York",
      "state": "NY",
      "zip": "10001",
      "country_code": "US",
      "address_type": "home",
      "is_primary": true
    }
  ]
}
'
{
  "id": "abc123xyz",
  "book_id": "book123xyz",
  "person": {
    "id": "abc123xyz",
    "book_id": "book123xyz",
    "first_name": "John",
    "last_name": "Doe",
    "household_id": "xyz789abc",
    "contact_id": "cnt456def",
    "role_type": "client",
    "middle_name": "Robert",
    "salutation": "Mr.",
    "suffix": "Jr.",
    "maiden_name": "Smith",
    "gender": "male",
    "designations": "CPA, CFP",
    "household_role": "head_of_household",
    "preferred_name": "Johnny",
    "date_of_birth": "1985-06-15",
    "job_title": "Software Engineer",
    "ssn": "***-**-6789",
    "drivers_license_number": "******7890",
    "email_addresses": [
      {
        "email": "john.doe@example.com",
        "email_type": "personal",
        "is_primary": true
      }
    ],
    "phone_numbers": [
      {
        "phone_number": "+15555551234",
        "phone_type": "mobile",
        "is_primary": true
      }
    ],
    "addresses": [
      {
        "address_type": "home",
        "is_primary": true,
        "line1": "123 Main St",
        "line2": "Apt 4B",
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "country_code": "US"
      }
    ],
    "employments": [
      {
        "business_name": "Acme Corp",
        "id": "emp123xyz",
        "person_id": "abc123xyz",
        "role": "Software Engineer",
        "start_date": "2023-01-15",
        "end_date": "2024-12-31",
        "actively_employed": true
      }
    ],
    "custom_fields": {
      "preferred_contact_method": "Email",
      "risk_tolerance": "Moderate"
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Headers

​
Idempotency-Key
string

Unique key to ensure idempotent request handling. If a request with the same key was already processed, the original response will be returned.

Body

application/json
​
book_id
string
required

The book ID

Example:

"abc123xyz"

​
first_name
string
required

First name

Example:

"John"

​
last_name
string
required

Last name

Example:

"Doe"

​
middle_name
string

Middle name

Example:

"Robert"

​
preferred_name
string

Preferred name

Example:

"Johnny"

​
salutation
string

Salutation

Example:

"Mr."

​
suffix
string

Suffix

Example:

"Jr."

​
gender
enum<string>

Gender

Available options:
female,
male,
nonbinary,
other,
prefer_not_to_say
Example:

"male"

​
designations
string

Professional designations

Example:

"CPA, CFP"

​
email_addresses
object[]

Array of email addresses

​
phone_numbers
object[]

Array of phone numbers

​
addresses
object[]

Array of addresses

Response

contact created

​
id
string
required

The contact ID

Example:

"abc123xyz"

​
book_id
string
required

The book ID

Example:

"book123xyz"

​
person
object
required
​
created_at
string<date-time>
required

When the contact was created

​
updated_at
string<date-time>
required

When the contact was last updated