Skip to main content
PATCH
/
v1
/
people
/
{id}
Update a person
curl --request PATCH \
  --url https://api.slant.app/v1/people/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "John",
  "last_name": "Doe",
  "middle_name": "Robert",
  "preferred_name": "Johnny",
  "salutation": "Mr.",
  "suffix": "Jr.",
  "gender": "male",
  "designations": "CPA, CFP",
  "household_role": "spouse",
  "date_of_birth": "1985-06-15",
  "job_title": "Software Engineer",
  "ssn": "123-45-6789",
  "drivers_license_number": "DL-1234567890",
  "custom_fields": {
    "preferred_contact_method": "Email"
  }
}
'
{
  "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"
  }
}

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.

Path Parameters

​
id
string
required

The person ID

Body

application/json
​
first_name
string

First name

Example:

"John"

​
last_name
string

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"

​
household_role
enum<string>

Role in the household

Available options:
head_of_household,
partner,
spouse,
dependent_child,
other_adult,
non_dependent_child,
other_dependent,
unknown,
deceased,
grandchild
Example:

"spouse"

​
date_of_birth
string<date>

Date of birth

Example:

"1985-06-15"

​
job_title
string

Job title

Example:

"Software Engineer"

​
ssn
string

Social security number

Example:

"123-45-6789"

​
drivers_license_number
string

Driver's license number

Example:

"DL-1234567890"

​
custom_fields
object

Custom field values as key-value pairs

Example:
{ "preferred_contact_method": "Email" }

Response

person updated

​
id
string
required

The person ID

Example:

"abc123xyz"

​
book_id
string
required

The book ID

Example:

"book123xyz"

​
first_name
string
required
Example:

"John"

​
last_name
string
required
Example:

"Doe"

​
household_id
string | null

The household ID

Example:

"xyz789abc"

​
contact_id
string | null

The contact ID (present when person belongs to a contact)

Example:

"cnt456def"

​
role_type
enum<string> | null

The entity type this person belongs to

Available options:
client,
prospect,
contact,
past_client
Example:

"client"

​
middle_name
string | null
Example:

"Robert"

​
salutation
string | null
Example:

"Mr."

​
suffix
string | null
Example:

"Jr."

​
maiden_name
string | null
Example:

"Smith"

​
gender
enum<string> | null
Available options:
female,
male,
nonbinary,
other,
prefer_not_to_say
Example:

"male"

​
designations
string | null
Example:

"CPA, CFP"

​
household_role
enum<string> | null

Only present when person belongs to a household

Available options:
head_of_household,
partner,
spouse,
dependent_child,
other_adult,
other_dependent,
unknown,
deceased,
non_dependent_child,
grandchild
Example:

"head_of_household"

​
preferred_name
string | null
Example:

"Johnny"

​
date_of_birth
string<date> | null

Date of birth

Example:

"1985-06-15"

​
job_title
string | null

Job title

Example:

"Software Engineer"

​
ssn
string | null

Obfuscated social security number

Example:

"***-**-6789"

​
drivers_license_number
string | null

Obfuscated driver's license number

Example:

"******7890"

​
email_addresses
object[]

Array of email addresses with primary designation

​
phone_numbers
object[]

Array of phone numbers with primary designation

​
addresses
object[]

Array of addresses with primary designation

​
employments
object[]

Array of employment records

​
custom_fields
object

Custom field values as key-value pairs

Example:
{
  "preferred_contact_method": "Email",
  "risk_tolerance": "Moderate"
}