SLslant
Related records

Create a related_record

Changed on

Create a related record link. The source must belong to book_id and both endpoints must be accessible. Use Household for clients/prospects, and the contact person ID with Person for contact sources.

post/v1/related_records

Request

  • Base URL
    https://api.slant.app
  • URL
    https://api.slant.app/v1/related_records
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

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

Request body

book_idstring required
source_type'Household' | 'Person' | 'Business' | 'Trust' | 'User' | 'Contact' required

Contact is resolved to its Person record in the saved link

source_idstring required
target_type'Household' | 'Person' | 'Business' | 'Trust' | 'User' | 'Contact' required
target_idstring required
relationship_to_sourcestring nullable

How the source relates to the target

relationship_to_targetstring nullable

How the target relates to the source

Response

related_record created

idstring required
book_idstring required
source_typestring required
source_idstring required
target_typestring required
target_idstring required
source_labelstring
target_labelstring
relationship_to_sourcestring nullable
relationship_to_targetstring nullable
created_atstring date-time
updated_atstring date-time

Changes