📘

When creating a role, set two of contact, company, opportunity and project, in one of the following combinations:

Contact and Company or Opportunity or Project

Company and Contact or Opportunity or Project

Opportunity and Company or Contact

Project and Company or Contact

🚧

Department

The department attribute is only applicable to roles between Contact and Company entities.

type is optional. Set it to a role type reference; the role's role name comes from the role type and can't be sent directly (doing so returns role_cannot_be_set).

{
  "contact": "/v1/contacts/1000",
  "company": "/v1/companies/1000",
  "type": "/v1/role_types/1000",
  "title": "Interim CEO",
  "department": "Executive"
}

A successful request returns 201 Created with the new role's reference, e.g. {"location": "/v1/roles/1000"}.

📘

Roles on records

You can also create roles from either record, e.g. through a contact's companies list. There, role sets the role type by name and creates it if needed.