API Reference›Servicing Workspace›Supercases›Bulk close subcases

Bulk close subcases

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/supercases/{supercaseId}/bulk/closeImplementedBearer token ·MANAGE_SERVICING_SUPERCASE&CLOSE_SERVICING_CASE

Closes the supercase’s open subcases through the ordinary close path, one transaction each, and returns both what closed and what each guard refused with its reason.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/supercases/$SUPERCASE_ID/bulk/close \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "outcomeCode": "DISASTER_RELIEF_CONCLUDED",
  "closureReason": "The declaration closed and every exposed borrower has been contacted.",
  "caseIds": [
    1042,
    1043,
    1044
  ]
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/supercases/${supercaseId}/bulk/close`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "outcomeCode": "DISASTER_RELIEF_CONCLUDED",
  "closureReason": "The declaration closed and every exposed borrower has been contacted.",
  "caseIds": [
    1042,
    1043,
    1044
  ]
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/supercases/{supercase_id}/bulk/close",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "outcomeCode": "DISASTER_RELIEF_CONCLUDED",
  "closureReason": "The declaration closed and every exposed borrower has been contacted.",
  "caseIds": [
    1042,
    1043,
    1044
  ]
},
)

{
  "supercaseId": 3301,
  "applied": [
    1042,
    1043
  ],
  "skipped": [
    {
      "caseId": 1044,
      "reason": "The case still has an open task"
    }
  ]
}

{
  "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.
supercaseId required in path	integer	Positive numeric supercase 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
closureReason required	string
caseIds optional	array<integer>

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/supercases/$SUPERCASE_ID/bulk/close \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "outcomeCode": "DISASTER_RELIEF_CONCLUDED",
  "closureReason": "The declaration closed and every exposed borrower has been contacted.",
  "caseIds": [
    1042,
    1043,
    1044
  ]
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/supercases/${supercaseId}/bulk/close`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "outcomeCode": "DISASTER_RELIEF_CONCLUDED",
  "closureReason": "The declaration closed and every exposed borrower has been contacted.",
  "caseIds": [
    1042,
    1043,
    1044
  ]
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/supercases/{supercase_id}/bulk/close",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "outcomeCode": "DISASTER_RELIEF_CONCLUDED",
  "closureReason": "The declaration closed and every exposed borrower has been contacted.",
  "caseIds": [
    1042,
    1043,
    1044
  ]
},
)

{
  "supercaseId": 3301,
  "applied": [
    1042,
    1043
  ],
  "skipped": [
    {
      "caseId": 1044,
      "reason": "The case still has an open task"
    }
  ]
}

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