Linking entities

This method allows linking entities to a lead, contact or company.

Limitations
The method is available in correspondence to the user rights.

Data type header when the request is successful
Content-Type: application/hal+json

Data type header in case of an error
Content-Type: application/problem+json

Response parameters

ParameterData typeDescription
to_entity_idintLinked entity ID
to_entity_typestringLinked entity types (leads, contacts, companies, catalog_elements)
metadataobject|nullLinked entity metadata
metadata[main_contact]boolDefines if the contact is main for the entity
metadata[quantity]intQuantity of the linked list elements
metadata[catalog_id]intList ID
metadata[updated_by]intThe ID of the user performing the linking
Language
Credentials
OAuth2
URL
Click Try It! to start a request and see the response here!