Set Worker Document Viewable - Roosted HR API Documentation

POST

workers

{id}

documents

{document_id}

Set Worker Document Viewable

curl --request POST \
  --url https://api.roostedhr.com/api/1_12/workers/{id}/documents/{document_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{}'

{
  "code": "WRK-1200",
  "error": "An unexpected error occurred while updating the document."
}

Set worker_viewable to 1 to allow the worker to see this document, or 0 to hide it.

Authorizations

X-API-KEY

string

header

required

Path Parameters

string

required

Worker ID

document_id

string

required

Document ID

Body

application/json

worker_viewable

enum<integer>

required

Whether the worker can view this document. 1 = viewable, 0 = hidden.

Available options:

0,

1

Response

Viewable status updated successfully

Delete Worker DocumentSoft-deletes a worker document. The document is marked as deleted but not permanently removed.

Set Worker Document Viewable

curl --request POST \
  --url https://api.roostedhr.com/api/1_12/workers/{id}/documents/{document_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{}'

{
  "code": "WRK-1200",
  "error": "An unexpected error occurred while updating the document."
}