HMhm-courts-and-tribunals-service
application-list-entries

Update an Application List Entry

Changed on

Full replacement (PUT) of an existing Application List Entry. When feeStatuses is supplied, the existing fee-status rows for the entry are replaced by the provided list. When feeStatuses is null, fee-status rows are left unchanged. On an Open Application List, the existing associated Application Code may be retained even if expired. Replacement codes must be valid on the current business date. Supplying the existing Standard Applicant code (case-insensitive) retains the associated record even after expiry, allowing updates to Officials and Fees. A newly selected or replacement Standard Applicant must be valid on the current business date. Closed Application List restrictions remain unchanged.

put/application-lists/{listId}/entries/{entryId}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /application-lists/{listId}/entries/{entryId}
  • Auth
    none declared

Path parameters

listIdstring uuid required

Public identifier of the Application List.

entryIdstring uuid required

Public identifier of the Application List Entry.

Request body

standardApplicantCodestring

Code that identifies the Standard Applicant. On an Open Application List, supplying the existing associated code (case-insensitive) retains the same Standard Applicant record, even after expiry. A newly selected or replacement applicant must be valid on the current business date.

applicationCodestring required

Code that identifies the Application Code. On an Open Application List, the existing associated code may be retained after expiry, preserving its configuration and Fee Reference. A replacement code must be valid on the current business date.

numberOfRespondentsinteger

Number of respondents required by the Application.

hasOffsiteFeeboolean

Indicates whether an off-site fee applies.

caseReferencestring

A reference code to identify a related case (maximum 15 characters).

accountNumberstring

The Applicant's account number (maximum 20 characters). Required when the Application Code starts with EF.

notesstring

Notes about the application or the hearing (maximum 4000 characters).

Example request

{
  "standardApplicantCode": "APP001",
  "applicationCode": "APP001",
  "applicant": {
    "person": {
      "name": {
        "title": "Mr, Mrs",
        "firstName": "John",
        "middleName": "James",
        "lastName": "Smith"
      },
      "contactDetails": {
        "addressLine1": "10 Downing Street",
        "addressLine2": "Westminster",
        "addressLine3": "London",
        "addressLine4": "Greater London",
        "addressLine5": "United Kingdom",
        "postcode": "SW1A 2AA",
        "phone": "01225 123456",
        "mobile": "07123456789",
        "email": "john-doe@gmail.com"
      }
    },
    "organisation": {
      "name": "ACME Industries LTD",
      "contactDetails": {
        "addressLine1": "10 Downing Street",
        "addressLine2": "Westminster",
        "addressLine3": "London",
        "addressLine4": "Greater London",
        "addressLine5": "United Kingdom",
        "postcode": "SW1A 2AA",
        "phone": "01225 123456",
        "mobile": "07123456789",
        "email": "john-doe@gmail.com"
      }
    }
  },
  "respondent": {
    "person": {
      "name": {
        "title": "Mr, Mrs",
        "firstName": "John",
        "middleName": "James",
        "lastName": "Smith"
      },
      "contactDetails": {
        "addressLine1": "10 Downing Street",
        "addressLine2": "Westminster",
        "addressLine3": "London",
        "addressLine4": "Greater London",
        "addressLine5": "United Kingdom",
        "postcode": "SW1A 2AA",
        "phone": "01225 123456",
        "mobile": "07123456789",
        "email": "john-doe@gmail.com"
      },
      "dateOfBirth": "1990-01-01"
    },
    "organisation": {
      "name": "ACME Industries LTD",
      "contactDetails": {
        "addressLine1": "10 Downing Street",
        "addressLine2": "Westminster",
        "addressLine3": "London",
        "addressLine4": "Greater London",
        "addressLine5": "United Kingdom",
        "postcode": "SW1A 2AA",
        "phone": "01225 123456",
        "mobile": "07123456789",
        "email": "john-doe@gmail.com"
      }
    }
  },
  "wordingFields": [
    {
      "key": "account-number",
      "value": "1234"
    }
  ],
  "feeStatuses": [
    {
      "paymentReference": "PAY-001",
      "paymentStatus": "PAID",
      "statusDate": "2025-12-01"
    }
  ],
  "hasOffsiteFee": true,
  "caseReference": "CASE-001",
  "accountNumber": "ACC-001",
  "notes": "Time is 10:31, we have convened to talk about Application...",
  "officials": [
    {
      "title": "Mr, Mrs",
      "surname": "Smith",
      "forename": "John",
      "type": "MAGISTRATE"
    }
  ]
}

Response

Returns the updated Application List Entry

idstring uuid required

Unique identifier of the Application List Entry.

listIdstring uuid required

The Unique identifier of the Application List this Entry belongs to.

standardApplicantCodestring

Code that identifies the Standard Applicant.

standardApplicantIdinteger nullable

ID that identifies the Standard Applicant.

applicationCodeIdinteger required

ID of the exact persisted Application Code association, including historical versions.

applicationCodestring required

Code that identifies the Application Code.

numberOfRespondentsinteger nullable required

Number of respondents required by the Application.

hasOffsiteFeeboolean

Indicates whether an off-site fee applies.

caseReferencestring

A reference code to identify a related case (maximum 15 characters).

accountNumberstring

The Applicants account number (maximum 20 characters).

notesstring

Notes about the application or the hearing (maximum 4000 characters).

lodgementDatestring date required

The date on which the application was submitted. Will be set to current date if omitted.

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "listId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "standardApplicantCode": "APP001",
  "applicationCode": "APP001",
  "applicant": {
    "person": {
      "name": {
        "title": "Mr, Mrs",
        "firstName": "John",
        "middleName": "James",
        "lastName": "Smith"
      },
      "contactDetails": {
        "addressLine1": "10 Downing Street",
        "addressLine2": "Westminster",
        "addressLine3": "London",
        "addressLine4": "Greater London",
        "addressLine5": "United Kingdom",
        "postcode": "SW1A 2AA",
        "phone": "01225 123456",
        "mobile": "07123456789",
        "email": "john-doe@gmail.com"
      }
    },
    "organisation": {
      "name": "ACME Industries LTD",
      "contactDetails": {
        "addressLine1": "10 Downing Street",
        "addressLine2": "Westminster",
        "addressLine3": "London",
        "addressLine4": "Greater London",
        "addressLine5": "United Kingdom",
        "postcode": "SW1A 2AA",
        "phone": "01225 123456",
        "mobile": "07123456789",
        "email": "john-doe@gmail.com"
      }
    }
  },
  "respondent": {
    "person": {
      "name": {
        "title": "Mr, Mrs",
        "firstName": "John",
        "middleName": "James",
        "lastName": "Smith"
      },
      "contactDetails": {
        "addressLine1": "10 Downing Street",
        "addressLine2": "Westminster",
        "addressLine3": "London",
        "addressLine4": "Greater London",
        "addressLine5": "United Kingdom",
        "postcode": "SW1A 2AA",
        "phone": "01225 123456",
        "mobile": "07123456789",
        "email": "john-doe@gmail.com"
      },
      "dateOfBirth": "1990-01-01"
    },
    "organisation": {
      "name": "ACME Industries LTD",
      "contactDetails": {
        "addressLine1": "10 Downing Street",
        "addressLine2": "Westminster",
        "addressLine3": "London",
        "addressLine4": "Greater London",
        "addressLine5": "United Kingdom",
        "postcode": "SW1A 2AA",
        "phone": "01225 123456",
        "mobile": "07123456789",
        "email": "john-doe@gmail.com"
      }
    }
  },
  "wording": {
    "template": "This is a test {{Applicant number}} with a date",
    "substitution-key-constraints": [
      {
        "key": "account-number",
        "value": "12345678",
        "constraint": {
          "type": "TEXT",
          "length": 1234
        }
      }
    ]
  },
  "feeStatuses": [
    {
      "paymentReference": "PAY-001",
      "paymentStatus": "PAID",
      "statusDate": "2025-12-01"
    }
  ],
  "hasOffsiteFee": true,
  "caseReference": "CASE-001",
  "accountNumber": "ACC-001",
  "notes": "Time is 10:31, we have convened to talk about Application...",
  "lodgementDate": "2025-12-01",
  "officials": [
    {
      "title": "Mr, Mrs",
      "surname": "Smith",
      "forename": "John",
      "type": "MAGISTRATE"
    }
  ]
}

Changes