Skip to main content
POST
Upload file to a document

Upload Format

This endpoint uses binary upload (not JSON:API format). Send the raw file content as the request body.

Required Headers

Example (cURL)

Status Transitions

  • Document must be in queued or processing status
  • After successful upload, status becomes available
  • If the document is already available or failed, the upload will be rejected

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Headers

Content-Disposition
string
required

File name in the format: attachment; filename="report.csv"

Path Parameters

id
integer
required

The unique identifier of the document to upload to

Body

application/octet-stream

Raw binary file content

Response

Document uploaded successfully

data
object