Skip to main content
POST
Create a related_record

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
source_type
enum<string>
required
Available options:
Household,
Person,
Business,
Trust,
User
source_id
string
required
target_type
enum<string>
required
Available options:
Household,
Person,
Business,
Trust,
User,
Contact
target_id
string
required
relationship_to_source
string | null

How the source relates to the target

relationship_to_target
string | null

How the target relates to the source

Response

related_record created

id
string
required
book_id
string
required
source_type
string
required
source_id
string
required
target_type
string
required
target_id
string
required
source_label
string
target_label
string
relationship_to_source
string | null
relationship_to_target
string | null
created_at
string<date-time>
updated_at
string<date-time>