API Reference›Servicing Plane›Interactions›Link an interaction to a case

Link an interaction to a case

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/interactions/{interactionId}/case-linksImplementedBearer token ·ASSOCIATE_SERVICING_INTERACTION

Links an interaction to a case with an operator-recorded reason, and sets the primary case when the interaction had none.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/interactions/$INTERACTION_ID/case-links \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "caseId": 1001,
  "linkReason": "Email concerns the open collections case."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/interactions/${interactionId}/case-links`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "caseId": 1001,
  "linkReason": "Email concerns the open collections case."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/interactions/{interaction_id}/case-links",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "caseId": 1001,
  "linkReason": "Email concerns the open collections case."
},
)

{
  "interactionId": 3001,
  "changes": {
    "caseId": 1001,
    "primaryCaseId": 1001
  },
  "resourceId": 3001
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "409",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "idempotency.request.in.flight",
  "errors": []
}

Path & query parameters

Field	Type	Description
LendEasy-Tenant required in header	string	Opaque active LendEasy tenant-registry identifier. Supply exactly one instance; no alternate tenant selector is accepted.
interactionId required in path	integer	Positive numeric interaction identifier.
Idempotency-Key optional in header	string	Optional replay key for this logical mutation. Omission creates a fresh server-owned key for this attempt; blank, repeated, or longer-than-50-character values are rejected.

Body parameters

Field	Type	Description
caseId required	integer	Stable opaque servicing case identifier.
linkReason optional	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/interactions/$INTERACTION_ID/case-links \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "caseId": 1001,
  "linkReason": "Email concerns the open collections case."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/interactions/${interactionId}/case-links`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "caseId": 1001,
  "linkReason": "Email concerns the open collections case."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/interactions/{interaction_id}/case-links",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "caseId": 1001,
  "linkReason": "Email concerns the open collections case."
},
)

{
  "interactionId": 3001,
  "changes": {
    "caseId": 1001,
    "primaryCaseId": 1001
  },
  "resourceId": 3001
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "409",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "idempotency.request.in.flight",
  "errors": []
}