API Reference›Servicing Plane›Portal contracts›Close a portal interaction

Close a portal interaction

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/portal-interactions/{interactionId}/closeImplementedBearer token ·CLOSE_PORTAL_INTERACTION

Marks a self-service interaction COMPLETED with an optional outcome, reason, and refreshed summary. An interaction that cannot be closed answers 422 with reason interaction.not_closeable.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/portal-interactions/$INTERACTION_ID/close \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "outcomeCode": "RESOLVED",
  "reasonCode": "QUESTION_ANSWERED",
  "transcriptSummary": "Borrower asked about her next due date and was answered in one reply."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/portal-interactions/${interactionId}/close`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "outcomeCode": "RESOLVED",
  "reasonCode": "QUESTION_ANSWERED",
  "transcriptSummary": "Borrower asked about her next due date and was answered in one reply."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/portal-interactions/{interaction_id}/close",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "outcomeCode": "RESOLVED",
  "reasonCode": "QUESTION_ANSWERED",
  "transcriptSummary": "Borrower asked about her next due date and was answered in one reply."
},
)

{
  "acknowledged": true
}

{
  "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
outcomeCode required	string
reasonCode required	string	Configured structured reason code.
transcriptSummary required	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/portal-interactions/$INTERACTION_ID/close \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "outcomeCode": "RESOLVED",
  "reasonCode": "QUESTION_ANSWERED",
  "transcriptSummary": "Borrower asked about her next due date and was answered in one reply."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/portal-interactions/${interactionId}/close`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "outcomeCode": "RESOLVED",
  "reasonCode": "QUESTION_ANSWERED",
  "transcriptSummary": "Borrower asked about her next due date and was answered in one reply."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/portal-interactions/{interaction_id}/close",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "outcomeCode": "RESOLVED",
  "reasonCode": "QUESTION_ANSWERED",
  "transcriptSummary": "Borrower asked about her next due date and was answered in one reply."
},
)

{
  "acknowledged": true
}

{
  "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": []
}