API Reference › Servicing Workspace › Servicing administration › Run one scheduled sweep now Run one scheduled sweep now POST https://sandbox.api.lendeasy.ai /v1/servicing/admin/sweeps/{sweepKey} /runs Implemented ADMIN_SERVICING_CONFIG
Runs one pass of one named sweep for the caller’s tenant with the steps, order and per-item boundaries the scheduled pass has, and reports each step’s item count with -1 marking a step that failed. It accepts no body, the sweep key is one of EVENT_POLL, MAINTENANCE, RESERVATION_EXPIRY, EMAIL, EXPIRY, MONITORING or FURNISHING, and a deployment that has not enabled manual runs answers 404.
cURL Node Python
Request
curl -X POST https://sandbox.api.lendeasy.ai /v1/servicing/admin/sweeps/$SWEEP_KEY/runs \
-H "Authorization: Bearer $TOKEN" \
-H "LendEasy-Tenant: $TENANT" \
-H "Idempotency-Key: $IDEMPOTENCY_KEY" await fetch(`https://sandbox.api.lendeasy.ai /v1/servicing/admin/sweeps/${sweepKey}/runs` , {
method: "POST" ,
headers: { Authorization: `Bearer ${token}` , "LendEasy-Tenant" : tenant, "Idempotency-Key" : idempotencyKey },
});requests.post(
f"https://sandbox.api.lendeasy.ai /v1/servicing/admin/sweeps/{sweep_key}/runs" ,
headers={"Authorization" : f"Bearer {token}" , "LendEasy-Tenant" : tenant, "Idempotency-Key" : idempotency_key},
)200 400 404
{
"sweepKey": "MAINTENANCE",
"steps": {
"effect executor": 2 ,
"promise evaluation": 0 ,
"snooze resume": 0 ,
"stranded-case detector": 1 ,
"action-request reconciliation": 0 ,
"seeded reminders": 3
},
"processed": 6 ,
"stepFailed": false
}{
"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": "404",
"defaultUserMessage": "The request could not be applied.",
"userMessageGlobalisationCode": "error.msg.resource.not.found",
"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. sweepKey required in path string Stable opaque sweepKey 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.
cURL Node Python
Request
curl -X POST https://sandbox.api.lendeasy.ai /v1/servicing/admin/sweeps/$SWEEP_KEY/runs \
-H "Authorization: Bearer $TOKEN" \
-H "LendEasy-Tenant: $TENANT" \
-H "Idempotency-Key: $IDEMPOTENCY_KEY" await fetch(`https://sandbox.api.lendeasy.ai /v1/servicing/admin/sweeps/${sweepKey}/runs` , {
method: "POST" ,
headers: { Authorization: `Bearer ${token}` , "LendEasy-Tenant" : tenant, "Idempotency-Key" : idempotencyKey },
});requests.post(
f"https://sandbox.api.lendeasy.ai /v1/servicing/admin/sweeps/{sweep_key}/runs" ,
headers={"Authorization" : f"Bearer {token}" , "LendEasy-Tenant" : tenant, "Idempotency-Key" : idempotency_key},
)200 400 404
{
"sweepKey": "MAINTENANCE",
"steps": {
"effect executor": 2 ,
"promise evaluation": 0 ,
"snooze resume": 0 ,
"stranded-case detector": 1 ,
"action-request reconciliation": 0 ,
"seeded reminders": 3
},
"processed": 6 ,
"stepFailed": false
}{
"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": "404",
"defaultUserMessage": "The request could not be applied.",
"userMessageGlobalisationCode": "error.msg.resource.not.found",
"errors": []
}