Update Publish List

post/extensions/roboledger/{graph_id}/operations/update-publish-list

Updates the publish list's name and/or description. Membership is managed via add/remove-member operations.

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

Name	Type	Description
`graph_id`required	string	Graph Id

Header parameters

Name	Type	Description
`Idempotency-Key`optional	string	Idempotency-Key

Request body

Required, application/json.

Field	Type	Description
`name`optional	string	New list name. Omit to leave unchanged.
`description`optional	string	New description. Omit to leave unchanged.
`list_id`required	string	The publish list to update.

Example request

curl

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/update-publish-list" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "list_id": "pl_01HVF8T0M2YTAY3BBNRH0V0",
  "name": "Senior Lenders"
}'

Responses

200 Successful Response

Field Type Description

operationrequired

string

Kebab-case operation name

operationIdrequired

string

op_-prefixed ULID for audit and SSE correlation

statusrequired

string

Operation lifecycle state

One of: completed, pending, failed

resultoptional

PublishListResponse

Command-specific result payload

PublishListResponse fields

Field	Type	Description
`id`required	string	List identifier (ULID).
`name`required	string	Human-readable list name.
`description`optional	string	Free-form description.
`member_count`optional	integer	Number of recipient graphs currently on the list. Default: `0`
`created_by`required	string	User ID that created the list.
`created_at`required	string (date-time)	When the list was created.
`updated_at`required	string (date-time)	Last metadata update (name/description).

atrequired

string

ISO-8601 UTC timestamp

createdByoptional

string

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

idempotentReplayoptional

boolean

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

Default: false

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