Appearance

Create Associations ​

Endpoint ​

http
POST /unified/crm/associations
Integrations supported
  • Attio
  • Close
  • Pipedrive
  • Salesforce

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body ​

Refer Writing data using Unified APIs

entity_id
string

The unique identifier for the entity.

Supported in
  • Attio
  • Close
  • Pipedrive
  • Salesforce
entity
string

The type of the entity.

All possible enum values:
  • accounts
  • opportunities
  • contacts
  • leads
Enum support by integration
  • Salesforce
    • accounts
    • opportunities
  • Attio
    • accounts
    • opportunities
    • contacts
  • Close
    • opportunities
    • contacts
  • Pipedrive
    • leads
    • contacts
Supported in
  • Attio
  • Close
  • Pipedrive
  • Salesforce
associations
object
Supported in
  • Attio
  • Close
  • Pipedrive
  • Salesforce
acocunts
object[]
id
string
contacts
object[]

Only when entity is leads

id
string
leads
object[]

Only when entity is opportunities or contacts

id
string
opportunities
object[]

Only when entity is accounts or contacts

id
string
accounts
object[]

Only when entity is leads or contacts

id
string
organizations
object[]

Only when entity is opportunities or contacts

id
string
remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

entity_id
string

The unique identifier for the entity.

entity
string

The type of the entity.

associations
object
acocunts
object[]
id
string
contacts
object[]
id
string
leads
object[]
id
string
opportunities
object[]
id
string
remote_data
object

Raw data returned from the remote API call.