Upload a exclusion file

Accepts a exclusion multipart upload with a file and optional metadata JSON part.

Body Params
file
required

The file to upload. Supported: XLSX, CSV, TXT, ZIP/GZIP containing a single file, and generic application/octet-stream.

metadata
object

Optional metadata controlling parsing and routing. For large-file flows, upload via pre-signed URL and reference it via source.objectKey (omit the file part).

Headers
integer
required

Tenant/client identifier used for routing and authorization.

string
enum
required

Semantic type of the uploaded file. See enum for allowed values.

string

Only when File-Type is 'MARGINS','EXCLUSION' etc. Declares the business variant/layout the rows apply to.

string

Explicit parser profile to apply (column mapping, formats, sheet name for XLSX, key schema, etc.). If omitted, the server may resolve a profile from (Client-Id, File-Type, File-Variant).

string
length ≤ 128

(RECOMMENDED). Unique key (e.g., UUID) to safely retry the same request. If a request with the same key was already processed, the server returns the original result.

string

(RECOMMENDED). HTTP message integrity for the request payload. Use 'sha-256' with a base64 value. Example: 'sha-256=:BASE64DIGEST:'. Validates that bytes received match what the client sent.

string
Defaults to utf-8

Character encoding for text files. Defaults to 'utf-8'. Not to be confused with HTTP Content-Encoding.

string
length between 1 and 8

Field separator for delimited text files (CSV, TSV, TXT). Defaults to ',' (CSV). For TSV use '\t'; for pipe-delimited use '|'.

string
enum
Defaults to true

Whether the first row of a CSV/TSV file is a header row. Defaults to true.

Allowed:
string

Comma-separated labels for routing/search/reporting (e.g., 'sap,august,promo').

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

413

Payload too large

415

Unsupported media type

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json