Documents

Update a document

Changes the type of a document, or turns its import offer off or on. A document that becomes an invoice of a purchase order goes to the parser again. dismissed: false shows the import offer again.

patch/api/v1/documents/{id}

Request

  • Base URL: https://app.sellerassistant.app (the document declares no server; this is the origin it was published from)
  • URL: https://app.sellerassistant.app/api/v1/documents/{id}
  • Auth: one of:
    • API key in query parameter api_key
    • API key in header X-Api-Key

Path parameters

idinteger required
Example:5

Request body

type'invoice' | 'confirmation' | 'credit_memo' | 'packing_slip' | 'contract' | 'authorization_letter' | 'credit_agreement' | 'other'
dismissedboolean

Response

The document

Example response

{
  "data": {
    "id": 5,
    "type": "invoice",
    "status": "parsed",
    "original_name": "invoice-2026-09.pdf",
    "mime_type": "application/pdf",
    "file_size": 240128,
    "reference_number": "INV-4471",
    "targets": [
      {
        "id": 42
      }
    ],
    "ai_confidence": 0.94,
    "has_parsed_data": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.