API Reference›LMS API›Servicing actions›Update an interest pause

Update an interest pause

PUThttps://sandbox.api.lendeasy.ai/v1/loans/{loanId}/interest-pauses/{variationId}Bearer token ·UPDATE_INTEREST_PAUSE

Adjusts the dates of an interest-pause period.

Request

curl -X PUT https://sandbox.api.lendeasy.ai/v1/loans/$LOAN_ID/interest-pauses/$VARIATION_ID \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "startDate": "2027-08-01",
  "endDate": "2027-11-30",
  "dateFormat": "yyyy-MM-dd",
  "locale": "en"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/loans/${loanId}/interest-pauses/${variationId}`, {
  method: "PUT",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "startDate": "2027-08-01",
  "endDate": "2027-11-30",
  "dateFormat": "yyyy-MM-dd",
  "locale": "en"
}),
});

requests.put(
  f"https://sandbox.api.lendeasy.ai/v1/loans/{loan_id}/interest-pauses/{variation_id}",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "startDate": "2027-08-01",
  "endDate": "2027-11-30",
  "dateFormat": "yyyy-MM-dd",
  "locale": "en"
},
)

{
  "resourceId": 12,
  "changes": {
    "endDate": "2027-11-30"
  }
}

{
  "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	Tenant selector: lowercase letters, digits, and hyphens, 1-64 characters. Exactly one instance; the only tenant selector honored.
loanId required in path	string	Stable opaque loan identifier.
variationId required in path	string	Stable opaque variation identifier.
LendEasy-Case optional in header	string	Open servicing-case reference for this borrower. Required on human servicing mutations when case management is enabled; automation never sends it.
Idempotency-Key optional in header	string	Optional stable key (1-50 chars) for this one logical mutation. Replays of a completed request return the original result with x-served-from-cache: true; an in-flight duplicate returns 409 with Retry-After. Omitted keys are server-generated per attempt.

Body parameters

Field	Type	Description
startDate required	string
endDate required	string
dateFormat required	string
locale required	string

Request

curl -X PUT https://sandbox.api.lendeasy.ai/v1/loans/$LOAN_ID/interest-pauses/$VARIATION_ID \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "startDate": "2027-08-01",
  "endDate": "2027-11-30",
  "dateFormat": "yyyy-MM-dd",
  "locale": "en"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/loans/${loanId}/interest-pauses/${variationId}`, {
  method: "PUT",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "startDate": "2027-08-01",
  "endDate": "2027-11-30",
  "dateFormat": "yyyy-MM-dd",
  "locale": "en"
}),
});

requests.put(
  f"https://sandbox.api.lendeasy.ai/v1/loans/{loan_id}/interest-pauses/{variation_id}",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "startDate": "2027-08-01",
  "endDate": "2027-11-30",
  "dateFormat": "yyyy-MM-dd",
  "locale": "en"
},
)

{
  "resourceId": 12,
  "changes": {
    "endDate": "2027-11-30"
  }
}

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