Remove Link between Parent and Child Record

Overview

Removes an existing link association between a parent record and a child record. The link is permanently deleted. If no matching link exists for the specified parent/child pair, the endpoint returns a non-error response with IsSuccessful: false.

Record Identification

Parent and child records can be identified in two ways:

1. By primary key (preferred): Provide ParentRecordID or ChildRecordID.
2. By match field: Provide both a key value and a field name (e.g., ParentRecordKey=POL-2026-001 + ParentRecordMatchField=PolicyNumber). Only text or numeric fields are accepted. Association fields are not allowed.

If both a primary key and a match field are provided for the same side, the primary key takes priority and the match field is ignored.

For Remove, you must identify one parent record AND one child record

Preconditions

• The authenticated user must have the appropriate permission on the parent domain (Detach Contacts for Contact links, Modify Files for File links, Edit for all others).
• ChildDomain must be "Contact" or "File".
• Either ParentRecordID or both ParentRecordKey and ParentRecordMatchField must be provided.
• Either ChildRecordID or both ChildRecordKey and ChildRecordMatchField must be provided.

Notes

• If the specified link does not exist, the response is 200 OK with IsSuccessful: false and a message indicating nothing was removed. This is not treated as an error.
• Relationship is only applicable when ChildDomain is Contact. Without it, any link between the specified parent and child is matched regardless of relationship. These fields are ignored for File links.

Examples

Scenario 1: Remove a contact link from a claim:

POST /api/Link/Remove
Content-Type: application/json

{
  "ParentDomain": "Claim",
  "ParentRecordID": 5001,
  "ChildDomain": "Contact",
  "ChildRecordID": 2001,
  "Relationship": "Adjuster"
}

200 OK
{
  "IsSuccessful": true,
  "RecordID": 101,
  "Message": "Deleted link with id 101 successfully.",
  "ParentID": 5001,
  "ChildID": 2001,
  "RelationshipID": 3
}

Scenario 2: Link does not exist:

POST /api/Link/Remove
Content-Type: application/json

{
  "ParentDomain": "Claim",
  "ParentRecordID": 5001,
  "ChildDomain": "Contact",
  "ChildRecordID": 9999
}

200 OK
{
  "IsSuccessful": false,
  "RecordID": 0,
  "Message": "A link does not exist.  Nothing to remove.",
  "ParentID": 5001,
  "ChildID": 9999,
  "RelationshipID": null
}

Scenario 3: Child domain is not a Contact or File:

POST /api/Link/Remove
Content-Type: application/json

{
  "ParentDomain": "Claim",
  "ParentRecordID": 5001,
  "ChildDomain": "Policy",
  "ChildRecordID": 100
}

500 Internal Server Error
"Unable to execute. Child Domain Policy is not supported as a linkable child type"