Relationship Type

Create a relationship type

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

See Relationship Type for the attributes. None are required, but you will normally send at least forward and reverse. For a relationship that reads the same both ways, such as "is the spouse of", use the same text for both.

{
  "forward": "is the parent company of",
  "reverse": "is the subsidiary of",
  "forward_title": "Parent Company",
  "reverse_title": "Subsidiary",
  "for_contact": false,
  "for_company": true
}

New relationship types are active and, unless you say otherwise, enabled for both contacts and companies. A successful request returns 201 Created with the new type's reference, e.g. {"location": "/v1/relationship_types/1000"}.

Body Params
string

Text that reads from the source to the destination, e.g. is the parent company of (max 512 characters).

string

Text that reads from the destination back to the source, e.g. is the subsidiary of (max 512 characters).

string

Short name for the source, e.g. Parent Company (max 256 characters).

string

Short name for the destination, e.g. Subsidiary (max 256 characters).

boolean

Whether the type can be used between contacts. Defaults to true.

boolean

Whether the type can be used between companies. Defaults to true.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json