Skip to main content
POST
/
capabilities
/
documents.bulk-edit
documents.bulk-edit
curl --request POST \
  --url https://developer.api.receiptor.ai/v1/capabilities/documents.bulk-edit \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changes": {
    "merchant": "<string>",
    "category": "<string>"
  },
  "query": "<string>",
  "merchant": "<string>",
  "category": "<string>",
  "dryRun": true
}
'
{
  "success": true,
  "code": 200,
  "data": {
    "result": {}
  }
}

Authorizations

x-api-key
string
header
required

API key prefixed with sk_. Obtain from the Receiptor AI dashboard.

Body

application/json
changes
object
required

Changes to apply to matching documents

query
string

Search query to find documents (optional)

merchant
string

Specific merchant to filter for editing

category
string

Specific category to filter for editing

dryRun
boolean
default:true

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

Response

Successful response

success
boolean
Example:

true

code
integer
Example:

200

data
object