RoboLedger: Ledger & Events

Update Agent

Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). classification_element_id sets the account this counterparty's bank lines are suggested (an empty string clears it), and classification_mode='always_ask' stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. Each entity of a group keeps its own default, on its own chart: classification_entity_id names the one these fields are for, omitted the group parent. A default is also learned as lines are committed, so set one by hand only to correct it.

Idempotency: supply an Idempotency-Key header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.

post/extensions/roboledger/{graph_id}/operations/update-agent

Request

  • Base URL: https://api.robosystems.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/update-agent
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

graph_idstring required

Headers

Idempotency-Keystring nullable

Request body

agent_idstring required

The agent to update.

namestring nullable
legal_namestring nullable
tax_idstring nullable
registration_numberstring nullable
dunsstring nullable
leistring nullable
emailstring nullable
phonestring nullable
addressobject nullable
is_activeboolean nullable

Toggle activation. Inactive agents are hidden from new-transaction pickers.

is_1099_recipientboolean nullable
classification_element_idstring nullable

The chart account this counterparty's bank lines are usually classified to, suggested on each new line. An empty string clears it. Its still-open lines are re-suggested at once. Omit to keep.

classification_mode'suggest' | 'always_ask' nullable

suggest offers the default on each line; always_ask offers none, for a counterparty whose lines go to different accounts. Omit to keep.

classification_entity_idstring nullable

The entity whose bank lines the default above is for. Each entity keeps its own default, on its own chart. Omit for the group parent.

metadata_patchobject

Deep-merged into agent.metadata. Pass {} to leave unchanged. The default classification is set with the fields above, not here.

Example request

{
  "agent_id": "agt_01HVF8T0M2YTAY3BBNRH0V0",
  "is_1099_recipient": true,
  "tax_id": "12-3456789"
}

Response

Successful Response

operationstring required

Kebab-case operation name

operationIdstring required

op_-prefixed ULID for audit and SSE correlation

status'completed' | 'pending' | 'failed' required

Operation lifecycle state

atstring required

ISO-8601 UTC timestamp

createdBystring nullable

User ID that initiated the operation

idempotentReplayboolean

True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.

Changes

No recorded changes to this operation across all 1 revision of this API.