Request a state change

POST/lokta-lms/api/v1/sourcing-partners/{partnerId}/state-change-requests

Requests a change of state for a sourcing partner, with a reason.

{"requested_state": "on_hold" | "deactivated" | "active", "reason": "…"}. A reason is required: the checker decides on it and the trail keeps it.

One open request per partner: a second is 409 sourcing/state_change_already_pending. Requesting active fails fast if the partner cannot be activated (external id, terms), and the same gate re-runs authoritatively at approval, because the world changes between request and decision.

Path parameters

partnerIdpath · string · required

Header parameters

Idempotency-Keyheader · string · optional

Per-intent key

Request body application/json

requested_statestring · required

The state being asked for.

One of: on_hold, deactivated, active

reasonstring · required

Required. The checker decides on it and the trail keeps it.

Responses

defaultdefault response

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 POST \ 'https://default.lokta.tech/lokta-lms/api/v1/sourcing-partners/{partnerId}/state-change-requests' \ -u '{username}:{password}' \ -H 'Tenant-Identifier: default' \ -H 'Content-Type: application/json' \ -d '{ "requested_state": "on_hold", "reason": "string" }'

import requests response = requests.post( "https://default.lokta.tech/lokta-lms/api/v1/sourcing-partners/{partnerId}/state-change-requests", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, json={ "requested_state": "on_hold", "reason": "string" }, ) print(response.json())

const response = await fetch("https://default.lokta.tech/lokta-lms/api/v1/sourcing-partners/{partnerId}/state-change-requests", { method: "POST", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", "Content-Type": "application/json", }, body: JSON.stringify({ "requested_state": "on_hold", "reason": "string" }), }); console.log(await response.json());

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://default.lokta.tech/lokta-lms/api/v1/sourcing-partners/{partnerId}/state-change-requests")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString(""" { "requested_state": "on_hold", "reason": "string" } """)) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

payload := strings.NewReader(`{ "requested_state": "on_hold", "reason": "string" }`) req, _ := http.NewRequest("POST", "https://default.lokta.tech/lokta-lms/api/v1/sourcing-partners/{partnerId}/state-change-requests", 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))