API Reference›Servicing Plane›Servicing administration›Replace case field definitions

Replace case field definitions

PUThttps://sandbox.api.lendeasy.ai/v1/servicing/admin/case-types/{caseTypeCode}/field-definitionsImplementedBearer token ·ADMIN_SERVICING_CONFIG

Replaces the closed configuration object for an existing case type without schema DDL.

Request

curl -X PUT https://sandbox.api.lendeasy.ai/v1/servicing/admin/case-types/$CASE_TYPE_CODE/field-definitions \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "fieldDefinitions": {
    "sections": [
      {
        "key": "service_details",
        "label": "Service details",
        "fields": [
          {
            "key": "requested_effective_date",
            "label": "Requested effective date",
            "type": "DATE",
            "requiredAt": "OPTIONAL"
          }
        ]
      }
    ]
  },
  "reason": "Add the requested effective date to support work."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/admin/case-types/${caseTypeCode}/field-definitions`, {
  method: "PUT",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "fieldDefinitions": {
    "sections": [
      {
        "key": "service_details",
        "label": "Service details",
        "fields": [
          {
            "key": "requested_effective_date",
            "label": "Requested effective date",
            "type": "DATE",
            "requiredAt": "OPTIONAL"
          }
        ]
      }
    ]
  },
  "reason": "Add the requested effective date to support work."
}),
});

requests.put(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/admin/case-types/{case_type_code}/field-definitions",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "fieldDefinitions": {
    "sections": [
      {
        "key": "service_details",
        "label": "Service details",
        "fields": [
          {
            "key": "requested_effective_date",
            "label": "Requested effective date",
            "type": "DATE",
            "requiredAt": "OPTIONAL"
          }
        ]
      }
    ]
  },
  "reason": "Add the requested effective date to support work."
},
)

{
  "resourceId": 11,
  "caseTypeCode": "GENERAL_SUPPORT",
  "changes": {
    "fieldKeys": [
      "requested_effective_date"
    ]
  }
}

{
  "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.
caseTypeCode required in path	string	Stable opaque caseTypeCode 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
fieldDefinitions required	object
sections	array<object>
reason required	string

Request

curl -X PUT https://sandbox.api.lendeasy.ai/v1/servicing/admin/case-types/$CASE_TYPE_CODE/field-definitions \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "fieldDefinitions": {
    "sections": [
      {
        "key": "service_details",
        "label": "Service details",
        "fields": [
          {
            "key": "requested_effective_date",
            "label": "Requested effective date",
            "type": "DATE",
            "requiredAt": "OPTIONAL"
          }
        ]
      }
    ]
  },
  "reason": "Add the requested effective date to support work."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/admin/case-types/${caseTypeCode}/field-definitions`, {
  method: "PUT",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "fieldDefinitions": {
    "sections": [
      {
        "key": "service_details",
        "label": "Service details",
        "fields": [
          {
            "key": "requested_effective_date",
            "label": "Requested effective date",
            "type": "DATE",
            "requiredAt": "OPTIONAL"
          }
        ]
      }
    ]
  },
  "reason": "Add the requested effective date to support work."
}),
});

requests.put(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/admin/case-types/{case_type_code}/field-definitions",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "fieldDefinitions": {
    "sections": [
      {
        "key": "service_details",
        "label": "Service details",
        "fields": [
          {
            "key": "requested_effective_date",
            "label": "Requested effective date",
            "type": "DATE",
            "requiredAt": "OPTIONAL"
          }
        ]
      }
    ]
  },
  "reason": "Add the requested effective date to support work."
},
)

{
  "resourceId": 11,
  "caseTypeCode": "GENERAL_SUPPORT",
  "changes": {
    "fieldKeys": [
      "requested_effective_date"
    ]
  }
}

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