API Reference›Servicing Plane›Scheduled callbacks›Cancel a callback

Cancel a callback

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/scheduled-callbacks/{taskId}/cancelImplementedBearer token ·CANCEL_SERVICING_SCHEDULED_CALLBACK

Cancels an unstarted promise outright, revokes any window-scoped consent, and records the change in the schedule history. Recorded as cancelled rather than completed: nobody called.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/scheduled-callbacks/$TASK_ID/cancel \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reasonCode": "CUSTOMER_CANCELLED",
  "note": "Customer withdrew the callback request."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/scheduled-callbacks/${taskId}/cancel`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "reasonCode": "CUSTOMER_CANCELLED",
  "note": "Customer withdrew the callback request."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/scheduled-callbacks/{task_id}/cancel",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "reasonCode": "CUSTOMER_CANCELLED",
  "note": "Customer withdrew the callback request."
},
)

{
  "taskId": 2001,
  "interactionId": 3001,
  "caseId": 1001,
  "status": "CANCELLED",
  "windowStart": "2026-07-26T15: 00:00Z",
  "windowEnd": "2026-07-26T15: 30:00Z",
  "scheduledZoneId": "America/Chicago"
}

{
  "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.
taskId required in path	integer	Positive numeric task 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
reasonCode required	string	Configured structured reason code.
note optional	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/scheduled-callbacks/$TASK_ID/cancel \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reasonCode": "CUSTOMER_CANCELLED",
  "note": "Customer withdrew the callback request."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/scheduled-callbacks/${taskId}/cancel`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "reasonCode": "CUSTOMER_CANCELLED",
  "note": "Customer withdrew the callback request."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/scheduled-callbacks/{task_id}/cancel",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "reasonCode": "CUSTOMER_CANCELLED",
  "note": "Customer withdrew the callback request."
},
)

{
  "taskId": 2001,
  "interactionId": 3001,
  "caseId": 1001,
  "status": "CANCELLED",
  "windowStart": "2026-07-26T15: 00:00Z",
  "windowEnd": "2026-07-26T15: 30:00Z",
  "scheduledZoneId": "America/Chicago"
}

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