The Mercury API allows you to manage related parties associated with an Opportunity record.
This includes:
Creating a related party
Fetching related parties
Updating a related party
Deleting (soft deleting) a related party
Create a related party
Endpoint
POST https://apis.connective.com.au/mercury/v1/{token}/opportunities/{id}/relatedPartiesSample request
{ "personID": "692cc6aa-14e2-11e7-a0a2-00155d009933", "relationship": "Primary applicant" }Sample response
{ "uniqueId": "7fae9794-14e2-11e7-a0a2-00155d009933" }The uniqueId represents the created related party record.
Fetch related parties for an Opportunity
Endpoint
GET https://apis.connective.com.au/mercury/v1/{token}/opportunities/{id}/relatedPartiesSample response
[ { "uniqueId": "7fae9794-14e2-11e7-a0a2-00155d009933", "personID": "692cc6aa-14e2-11e7-a0a2-00155d009933", "relationship": "Primary applicant" } ]This returns all related parties associated with the specified Opportunity.
Update a related party
Endpoint
PUT https://apis.connective.com.au/mercury/v1/{token}/opportunities/{id}/relatedParties/{relatedPartyId}Sample request
{ "relationship": "Secondary applicant" }This updates the relationship type for the specified related party.
Delete a related party (soft delete)
Endpoint
PUT https://apis.connective.com.au/mercury/v1/{token}/opportunities/{id}/relatedParties/{relatedPartyId}Sample request
{ "isDeleted": true }This performs a soft delete of the related party record.
Important notes
Replace
{token}with your valid API authentication token.Replace
{id}with the Opportunity ID.Replace
{relatedPartyId}with the related party’suniqueId.Deleting a related party uses a soft delete (
isDeleted: true) rather than a DELETE method.
Need help?
If you require assistance with Mercury API integrations, contact your Partnership Manager or email [email protected].