Update a Client

PUT/lokta-lms/api/v1/clients/{clientId}

Note: You can update any of the basic attributes of a client (but not its associations) using this API.

Changing the relationship between a client and its office is not supported through this API. An API specific to handling transfers of clients between offices is available for the same.

Path parameters

clientIdpath · integer · int64 · required

clientId

Request body application/json

externalIdstring · optional

firstnamestring · optional

lastnamestring · optional

resourceExternalIdstring · optional

Responses

200OK

Response fields

changesPutClientsClientIdRequest · optional

PutClientsClientIdRequest

clientIdinteger · int64 · optional

officeIdinteger · int64 · optional

resourceExternalIdstring · optional

resourceIdinteger · int64 · optional

Every request authenticates with HTTP Basic and carries a Tenant-Identifier header. See the conventions for dates, commands, pagination and errors. Open this operation in the interactive explorer, or read it as Markdown.

This is the API reference for Lokta, the agentic loan servicing platform. Go to lokta.ai

curl -X PUT \ 'https://default.lokta.tech/lokta-lms/api/v1/clients/{clientId}' \ -u '{username}:{password}' \ -H 'Tenant-Identifier: default' \ -H 'Content-Type: application/json' \ -d '{ "externalId": "786444UUUYYH7", "firstname": "Client_FirstName", "lastname": "Client_LastName", "resourceExternalId": "123-456" }'

import requests response = requests.put( "https://default.lokta.tech/lokta-lms/api/v1/clients/{clientId}", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, json={ "externalId": "786444UUUYYH7", "firstname": "Client_FirstName", "lastname": "Client_LastName", "resourceExternalId": "123-456" }, ) print(response.json())

const response = await fetch("https://default.lokta.tech/lokta-lms/api/v1/clients/{clientId}", { method: "PUT", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", "Content-Type": "application/json", }, body: JSON.stringify({ "externalId": "786444UUUYYH7", "firstname": "Client_FirstName", "lastname": "Client_LastName", "resourceExternalId": "123-456" }), }); console.log(await response.json());

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://default.lokta.tech/lokta-lms/api/v1/clients/{clientId}")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .header("Content-Type", "application/json") .method("PUT", HttpRequest.BodyPublishers.ofString(""" { "externalId": "786444UUUYYH7", "firstname": "Client_FirstName", "lastname": "Client_LastName", "resourceExternalId": "123-456" } """)) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

payload := strings.NewReader(`{ "externalId": "786444UUUYYH7", "firstname": "Client_FirstName", "lastname": "Client_LastName", "resourceExternalId": "123-456" }`) req, _ := http.NewRequest("PUT", "https://default.lokta.tech/lokta-lms/api/v1/clients/{clientId}", payload) req.SetBasicAuth("{username}", "{password}") req.Header.Set("Tenant-Identifier", "default") req.Header.Set("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() data, _ := io.ReadAll(res.Body) fmt.Println(string(data))

{ "changes": { "externalId": "786444UUUYYH7", "firstname": "Client_FirstName", "lastname": "Client_LastName", "resourceExternalId": "123-456" }, "clientId": 1, "officeId": 1, "resourceExternalId": "123-456" }