Skip to main content
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 '
{
  "worker_viewable": 0
}
'
{
  "code": "WRK-1200",
  "error": "An unexpected error occurred while updating the document."
}

Documentation Index

Fetch the complete documentation index at: https://docs.roostedhr.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
id
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