Skip to main content
PATCH
/
clients
/
{id}
/
workers
/
{worker_id}
/
status
Edit Client Worker Status
curl --request PATCH \
  --url https://api.roostedhr.com/api/1_12/clients/{id}/workers/{worker_id}/status \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "status": "preferred"
}
'
true

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.

The three status values are:
  • preferred — Worker gets priority when scheduling this client’s events.
  • normal — Default status; worker is eligible but not prioritized.
  • banned — Worker is excluded from this client’s events.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Client ID

​
worker_id
string
required

Worker ID

Body

application/json

The new worker status.

​
status
enum<string>
required

Worker's preference status. preferred = priority scheduling, normal = default, banned = excluded from client events.

Available options:
preferred,
normal,
banned

Response

OK

The response is of type boolean.