Upload a file

Upload a document to a report as multipart form data (up to 10 MB). Target the report by its Kalepa report ID or by your own external_id in the report_id form field (auto-detected by shape; use id_type to force it, and org_group / sub_org_group to select a scope when targeting by external_id). Optionally set a client file type and tags. Returns the created file's ID and name; client_file_type and tags are echoed back only where enabled for your organization.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
file

file to be appended - maximum size of the file is 10 MB

string

The Kalepa report ID, or the external_id you set on the report (auto-detected by shape; use id_type to force it, and org_group / sub_org_group to select a scope).

string | null
enum

Overrides how report_id is read: uuid (the Kalepa report ID) or external_id (your own identifier). Omit for auto-detect by shape.

Allowed:
string | null

Used only when the report is targeted by external_id: exact match on the report's org_group. An empty value matches reports with no org_group. Omit to skip the filter.

string | null

Used only when the report is targeted by external_id: exact match on the report's sub_org_group. An empty value matches reports with no sub_org_group. Omit to skip the filter.

string | null

general comment about the file

string | null

File type for the client to use

string | null

File tags string encoded as a JSON array

Responses

400

The request is invalid, or the external_id in report_id matches more than one report (error code AMBIGUOUS_IDENTIFIER, in the response body at detail.code). Narrow with org_group / sub_org_group, or use the Kalepa report ID. id_type=uuid with a value that is not a Kalepa report ID, and an unknown id_type, are also 400.

401

The bearer token is missing or invalid.

403

The authenticated client is not permitted to access this resource (e.g. insufficient permissions or org-group scope).

404

No report available to your API client matches report_id.

422

The request was well-formed, but the server refused to process it.

500

An unexpected error occurred.

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