Skip to main content
PUT
Python

Authorizations

Authorization
string
header
required

nia_sk_...

Body

application/json

A write of an agent's working state, by its code and never by a model: cas replaces the whole state at if_version (0 when it must not exist yet); merge_by_key replaces each top-level field it names and removes a field written as exactly {"$delete": true}.

agent
string
required
Required string length: 1 - 256
body
Body · object
required
mode
enum<string>
required
Available options:
cas,
merge_by_key
scope
AgentStateScope · object
required

What one working state belongs to. The id travels in the body, never in a URL: a conversation id may look like a phone number.

if_version
integer | null
Required range: x >= 0
subject
Handle · object | null

The customer the state is about, when its scope does not name them: erasing the customer and their data package find the state by it.

Response

Successful Response

stored
boolean
required
version
integer
required
reason
enum<string> | null
Available options:
over_cap,
not_declared_field