Connect Fields¶
Use connect fields to create custom relationships between records. Common examples include keeping track of the relationship between parent/child companies, people to people referrals, assignments, managers, investors and more. For more use cases, please refer to this help article.
How connect field values are read and written¶
Connect field values aren't stored on the record the way other custom fields are. You read and manage them through their own endpoints, not through custom_fields:
- List the connections on specified entity to read the current connections.
- Create a connection to add one.
- Delete a connection to remove one.
Updating records that have connect fields
On read, connect fields appear in a record's custom_fields as [], so sending that back on an update deletes their connections. If your integration reads records and writes them back, see Updating records that have connect fields first.