LendEasy/Docs
Get API keys
API ReferenceServicing PlanePromisesCancel a promise

Cancel a promise

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/promises/{promiseId}/cancel Bearer token · CANCEL_PROMISE

Cancels an active promise with effective time and structured reason.

Path & query parameters

FieldTypeDescription
promiseId required in pathstringStable opaque promise identifier.
Idempotency-Key required in headerstringStable key for this one logical mutation. Reuse it for retries; reusing it with a different request returns 409.

Body parameters

FieldTypeDescription
reasonCode requiredstringConfigured structured reason code.
effectiveAt requiredstring
expectedVersion requiredinteger
Unified search across guides, recipes & the API referenceEsc