Skip to main content
POST
Create a client

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

Client data. Provide either head_of_household (advanced) or flat person fields (simple).

book_id
string
required

The book ID

Example:

"abc123xyz"

household_name
string

Name of the household

Example:

"The Smith Family"

tier
string

Client tier label (e.g., "A-tier", "B-tier", etc.)

Example:

"B-tier"

became_client_at
string<date-time>

When the household became a client

Example:

"2024-01-01T00:00:00Z"

first_name
string

Simple format: Head of household first name

Example:

"John"

last_name
string

Simple format: Head of household last name

Example:

"Doe"

preferred_name
string

Simple format: Preferred name

Example:

"Johnny"

email
string<email>

Simple format: Primary email address

Example:

"john.doe@example.com"

phone_number
string

Simple format: Primary phone number

Example:

"5555551234"

phone_extension
string

Simple format: Optional phone extension for the primary phone number

Example:

"1234"

date_of_birth
string<date>

Simple format: Date of birth (YYYY-MM-DD)

Example:

"1990-01-15"

job_title
string

Simple format: Job title

Example:

"Software Engineer"

ssn
string

Simple format: Social security number for head of household

Example:

"123-45-6789"

drivers_license_number
string

Simple format: Driver's license number for head of household

Example:

"DL-1234567890"

head_of_household
object

Advanced format: Full person schema with nested contacts. Takes priority over flat fields if provided.

custom_fields
object

Household custom field values as key-value pairs

Example:

Response

client created

id
string
required

The ID of the household

Example:

"abc123xyz"

type
enum<string>
required

The type of household

Available options:
Client,
Prospect
Example:

"Client"

name
string
required

The name of the household

Example:

"The Smith Family"

book_id
string
required

The ID of the book this household belongs to

Example:

"book123xyz"

people
object[]
required

The people in this household

tier
string | null

The tier label for this household (null for Prospects)

Example:

"Platinum"

became_client_at
string<date-time> | null

When this household became a client

Example:

"2024-01-01T00:00:00Z"

profile_picture_url
string<uri> | null

URL to the household profile picture

Example:

"https://api.example.com/v1/households/abc123xyz/avatar"

custom_fields
object

Custom field values as key-value pairs

Example: