Add a relationship
Link a contact to somebody else in the same vault.
The other person is an existing contact named by other_contact, somebody new named by first_name, or, when you send neither, somebody whose name is unknown. Somebody new has no record of their own unless creates_record is true.
Linking somebody to themselves, using a type that is switched off, or making somebody their own ancestor answers 422, naming other_contact or relationship_type.
Parameters
Sent as JSON. Anything not listed here is ignored.
The vault both people live in, named either by the readable name it reports as slug or by its id.
One of the two people, named either by their slug or by their id. A contact addressed through the wrong vault answers 404.
The id of a relationship type of your account. A type that is switched off answers 422.
The other person, a contact of the same vault, named by their slug or their id. Not allowed with first_name or last_name.
The first name of somebody who has no record of their own. Up to 255 characters.
Their last name. Needs first_name.
True to give that person a full record of their own in the vault.
Whether the contact in the address holds role_a and the other person role_b. For a parent and child type, true says the contact is the parent. Ignored for a symmetric type. True when left out.
Returns
The relationship object that was added.
The relationship.
Always relationship. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.
The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.
Everything the record holds.
What the link is.
The id of the relationship type.
The name of the relationship type.
True when both people hold the same role, as partners do.
The person holding role_a.
The id of the contact.
The readable name of the contact, which addresses it as well as its id.
The name of the contact, as it is shown.
True for somebody who exists only through a relationship and has no record of their own.
The role this person holds, which is the type's role_a.
The person holding role_b.
The id of the contact.
The readable name of the contact, which addresses it as well as its id.
The name of the contact, as it is shown.
True for somebody who exists only through a relationship and has no record of their own.
The role this person holds, which is the type's role_b.
current or ended.
When it started, written as a year, a month and a day, or null.
When it ended, or null. Always null while the relationship is current.
When the relationship was recorded, as a count of seconds since 1970.
When it last changed, as a count of seconds. Equal to created_at until it first changes.
Where to find this record.
The absolute address this record is read from.
Rate limit
Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.
Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.