Browse the API reference

Update Entity

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

Part of Extensions: RoboLedger.

Update the graph's primary entity. Only provided (non-null) fields are updated. The graph is implicit in the URL — the operation always targets the graph's primary entity.

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.

Authentication

Authenticate in any one of these ways — not all of them:

  • API key in the X-API-Key header.
  • Bearer token in the Authorization header.

Path parameters

NameTypeDescription
graph_idrequiredstringGraph Id

Header parameters

NameTypeDescription
Idempotency-KeyoptionalstringIdempotency-Key

Request body

Required, application/json.

FieldTypeDescription
nameoptionalstring
legal_nameoptionalstring
urioptionalstring
cikoptionalstring
tickeroptionalstring
exchangeoptionalstring
sicoptionalstring
sic_descriptionoptionalstring
categoryoptionalstring
state_of_incorporationoptionalstring
fiscal_year_endoptionalstring

Fiscal year-end as MM-DD (e.g. '12-31', '06-30').

tax_idoptionalstring
leioptionalstring
industryoptionalstring
entity_typeoptionalstring
phoneoptionalstring
websiteoptionalstring
address_line1optionalstring
address_cityoptionalstring
address_stateoptionalstring
address_postal_codeoptionalstring
address_countryoptionalstring

Example request

curl
curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/update-entity" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "entity_type": "corporation",
  "fiscal_year_end": "12-31",
  "legal_name": "Acme Corporation, Inc.",
  "name": "Acme Corp",
  "state_of_incorporation": "DE",
  "tax_id": "12-3456789"
}'

Responses

200 Successful Response

FieldTypeDescription
operationrequiredstring

Kebab-case operation name

operationIdrequiredstring

op_-prefixed ULID for audit and SSE correlation

statusrequiredstring

Operation lifecycle state

One of: completed, pending, failed

resultoptionalLedgerEntityResponse

Command-specific result payload

LedgerEntityResponse fields
FieldTypeDescription
idrequiredstring

Entity identifier (ULID).

namerequiredstring

Display name shown in UI.

legal_nameoptionalstring

Full registered legal name (when different from `name`).

urioptionalstring

Canonical URL / external identifier.

cikoptionalstring

SEC CIK (Central Index Key).

tickeroptionalstring

Stock ticker symbol.

exchangeoptionalstring

Listing exchange (e.g. 'NASDAQ', 'NYSE').

sicoptionalstring

SIC industry code.

sic_descriptionoptionalstring

SIC code description.

categoryoptionalstring

Filer category (e.g. 'Large Accelerated Filer').

state_of_incorporationoptionalstring

US state or country of incorporation.

fiscal_year_endoptionalstring

Fiscal year-end as MM-DD (e.g. '12-31', '06-30').

tax_idoptionalstring

Tax ID (EIN / SSN).

leioptionalstring

Legal Entity Identifier (ISO 17442).

industryoptionalstring

Free-form industry label.

entity_typeoptionalstring

Legal form (e.g. 'corporation', 'llc', 'lp').

reporting_style_idoptionalstring

Active Reporting Style (Structure id) governing this entity's statement layout. Change it via the change-reporting-style operation.

phoneoptionalstring
websiteoptionalstring
statusoptionalstring

Operational status: 'active' | 'inactive' | 'dissolved'.

Default: active

is_parentoptionalboolean

True for top-level entities; False for subsidiaries.

Default: true

parent_entity_idoptionalstring

Parent entity ID for subsidiaries; null for top-level.

sourceoptionalstring

Provenance: 'native' | 'sec' | 'quickbooks' | 'xero' | 'plaid'.

Default: native

source_idoptionalstring

Source-system primary key for sync reconciliation.

source_graph_idoptionalstring

Origin graph for received entities (cross-graph linking, e.g. RoboInvestor portfolio holdings).

connection_idoptionalstring

Source connection that ingested this row.

address_line1optionalstring
address_cityoptionalstring
address_stateoptionalstring
address_postal_codeoptionalstring
address_countryoptionalstring
created_atoptionalstring
updated_atoptionalstring
atrequiredstring

ISO-8601 UTC timestamp

createdByoptionalstring

User ID that initiated the operation (null for legacy callers)

idempotentReplayoptionalboolean

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

Default: false

StatusMeaning
400Invalid request
401Authentication required
403Access denied
404Resource not found
409Idempotency-Key conflict — key reused with different body
422Validation error
429Rate limit exceeded
500Internal server error