API Reference›Servicing Plane›Hardship›Activate a guardrail version

Activate a guardrail version

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/guardrails/{versionId}/activateImplementedBearer token ·ACTIVATE_SERVICING_HARDSHIP_POLICY

Puts the guardrail version into force as the single active portfolio ceiling, retiring its predecessor in the same transaction. The bounds take effect on the next policy validation.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/guardrails/$VERSION_ID/activate \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "Approved widening of the document deadline for declared-disaster relief.",
  "expectedVersion": 2
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/guardrails/${versionId}/activate`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "reason": "Approved widening of the document deadline for declared-disaster relief.",
  "expectedVersion": 2
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/guardrails/{version_id}/activate",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "reason": "Approved widening of the document deadline for declared-disaster relief.",
  "expectedVersion": 2
},
)

{
  "resourceId": 7502,
  "changes": {
    "guardrailVersionId": 7502,
    "operation": "ACTIVATE"
  }
}

{
  "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.
versionId required in path	string	Stable opaque version 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
reason required	string
expectedVersion optional	integer

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/guardrails/$VERSION_ID/activate \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "Approved widening of the document deadline for declared-disaster relief.",
  "expectedVersion": 2
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/guardrails/${versionId}/activate`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "reason": "Approved widening of the document deadline for declared-disaster relief.",
  "expectedVersion": 2
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/guardrails/{version_id}/activate",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "reason": "Approved widening of the document deadline for declared-disaster relief.",
  "expectedVersion": 2
},
)

{
  "resourceId": 7502,
  "changes": {
    "guardrailVersionId": 7502,
    "operation": "ACTIVATE"
  }
}

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