/bff/purchase-document/sources/upsert

Create or update an ingestion source.

PurchaseDocumentSourcepostBffPurchase-documentSourcesUpsert

Parameters

JSON body

Request body

application/json

idstring | nullOptional

One of 2:

Variant 1

string

Length: 16–16

Variant 2

null

kind"email-forwarding" | "imap" | "api-push" | "fio-attachment"Required

Ingestion channel for received documents.

namestringRequired

Length: 1–96

configobjectOptional

Per-kind config payload (shape depends on kind).

isEnabledbooleanOptional

Default: true

imapPasswordPlainstring | nullOptional

One of 2:

Variant 1

string

Length: 0–256

Variant 2

null

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json

{
  "success": true
}

Request example

POST /bff/purchase-document/sources/upsert

post

curl -X POST "https://api.bizkithub.com/bff/purchase-document/sources/upsert" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "name": "example_name",
  "config": {},
  "isEnabled": true
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key