Skip to main content

Overview

A relationship attribute links a record to records in another object. For example, a subscription can belong to one company, while a company can have many subscriptions. This lets the subscription keep its own fields while remaining connected to the company it describes. Creating the attribute defines which records can be linked. Your integration or API must then supply the links between individual records.

Decide how many records can be linked

For each direction, choose how many related records a single record can have. The same company–subscription relationship is many to one when read from the subscription side. Read both directions before saving. One means at most one related record; many allows several. At least one direction must allow many records.

Create the relationship

Start with both objects already defined. This example links a subscription to a company.
1

Choose the relationship type

Open the subscription object in Settings → Data management. In Attributes, click Create attribute, then choose Relationship as the Attribute type.
2

Name both sides

Under Configure relationship, select the company object on the right. Name the attribute on the subscription Company, and name the attribute on the company Subscriptions. Review both generated API names.These names describe what someone will find when reading each object: the company for a subscription, and the subscriptions for a company.
3

Set the relationship size

Set the subscription’s direction to one company and the company’s direction to many subscriptions. Review the two has statements together to check that they describe your data.
4

Save and populate the relationship

Click Create attribute. Check the relationship attributes on both objects. Your integration or API can now link individual subscription records to their company records.Inspect a record after sending data to confirm that the expected relationship is populated.

Change an existing relationship

The related object and API names are fixed after creation. The editor can expand a relationship from one to many, but cannot narrow many to one. Review the effect on the workflows and integrations that consume the relationship before expanding it. Older reference attributes may link in one direction only. The editor shows these with a single relationship arrow. In the API, relationship attributes use the reference type. See Create an attribute with the API for programmatic setup.