capsule

Set or clear one field across many capsules, with a dry run that counts first

post/api/preview/capsules/batch/edit-fields

Request

Base URL
https://symbol.chat (the document declares no server; this is the origin it was published from)
Auth
- HTTP bearer
- or API key in cookie __Secure-next-auth.session-token
- or OAuth 2
  Authorization codehttps://mcp.symbol.chat/authorize
  Token URLhttps://mcp.symbol.chat/token
TypeScript
https://skmtc.dev/symbol-chat/apis/symbol-api/docs/api/preview/capsules/batch/edit-fields/post.ts
A function with typed inputs. Its response is checked against the schema.

action'set' | 'clear' required

set writes value to the field; clear removes the field's value.

capsuleIdsstring[] required

Capsule UUIDs to operate on

dry_runboolean

When true, nothing is written: the response reports, per capsule, what the edit would do.

fieldstring required

Name of the field to edit, as declared on each capsule's Type.

Successful response

batch_idstring nullable

UUID v4 string

dry_runboolean required

Nov 8, 2026fd7b0a7085e4 Revision changes
- info
  added the optional property // to the response with the status
Oct 27, 20263a2c4ebeab51 Revision changes
- info
  added the optional property // to the response with the status