API - How to Relate a Custom Object to a Contact

How to relate an existing Custom Object to a contact.

Route

POST /customobjects/link?apitoken=your-token&i=your-instance

Query Params

Key	Description
i	Identifier of your instance, subdomain.
apitoken	API token.

Body

Key	Description
objectId	ID of the created Object. If it was created via API, it is returned by this call.
linkType	Must be "lead".
targetId	ID of the contact within Sprinthub that will be related to the Custom Object.
amount	Must be 1.

Testing Custom Object Relationship

The request was sent using the software Postman. The expected response is an object representing the relationship between the Object and the lead.

Request to relate a Custom Object to a contact.

Checking in the Lead's Full Data

When relating a Custom Object to a contact, it should appear as in the image below.

Custom Object tab within the contact.