Skip to main content
POST
/
clients
/
{id}
/
documents
Upload Client Document
curl --request POST \
  --url https://api.roostedhr.com/api/1_12/clients/{id}/documents \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "file": "<string>",
  "name": "<string>"
}
'
{
  "id": 123,
  "name": "<string>",
  "file_name": "<string>",
  "date_added": "<string>",
  "type": "<string>",
  "location": "<string>",
  "deleted": 123,
  "date_deleted": "2023-11-07T05:31:56Z"
}
Upload files using multipart/form-data encoding. The maximum file size is 50 MB.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Client ID

Body

application/json

Document upload via base64-encoded file content.

​
file
string
required

Base64-encoded file content (supported types: JPEG, PNG, GIF, BMP, WebP, PDF).

​
name
string

Display name for the document. Defaults to auto-generated name based on file type.

Response

Created

​
id
integer

Unique document identifier.

​
name
string

Document display name.

​
file_name
string

Original uploaded file name.

​
date_added
string

Datetime when the document was uploaded.

​
type
string

Document MIME type or file extension.

​
location
string

URL to the stored document file.

​
deleted
integer

Soft-delete flag (0 = active, 1 = deleted).

​
date_deleted
string<date-time> | null

Timestamp when the document was soft-deleted, or null if active.