Browse the API reference

Add Members to Publish List

post/extensions/roboledger/{graph_id}/operations/add-publish-list-members

Part of Extensions: RoboLedger.

Add one or more recipient graphs to a publish list. Targets must exist and have the same extension enabled (e.g. roboledger). Self-graph rejected (422); already-member rejected (409).

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
target_graph_idsrequiredstring[]

Graph IDs to add. Each must exist and have the same extension (roboledger / roboinvestor) enabled. Self-graph rejected.

list_idrequiredstring

The publish list to add members to.

Example request

curl
curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/add-publish-list-members" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "list_id": "pl_01HVF8T0M2YTAY3BBNRH0V0",
  "target_graph_ids": [
    "kg_abc12345",
    "kg_def67890"
  ]
}'

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

resultoptionalPublishListMemberResponse[]

Command-specific result payload

PublishListMemberResponse fields
FieldTypeDescription
idrequiredstring

Membership row identifier (ULID).

target_graph_idrequiredstring

Recipient graph ID.

target_graph_nameoptionalstring

Display name of the recipient graph (if known).

target_org_nameoptionalstring

Display name of the org that owns the recipient graph.

added_byrequiredstring

User ID that added this member.

added_atrequiredstring (date-time)

When the member was added.

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