v3

latestOpenAPI 3.0.02026-07-31800117.7 KB

Capabilities

documents.bulk-edit

Bulk edit documents. Supports dry-run preview (default) and execute modes. Preview returns matching documents with proposed changes and available merchants/categories for context.

post/capabilities/documents.bulk-edit

Request body

documentIdsstring[]

Exact document IDs to edit. Use this for deterministic single-document or hand-picked multi-document edits.

querystring

Search query to find documents (optional)

merchantstring

Specific merchant to filter for editing

categorystring

Specific category to filter for editing

dryRunboolean

If true, shows preview without making changes. If false, executes the bulk edit.

Response

Successful response

successboolean

codeinteger

Example response

{
  "success": true,
  "code": 200
}