Skip to content
Recruso API

Create an availability status

POST
/v1/availability-statuses
curl --request POST \
  --url https://api2.recruso.co.uk/v1/availability-statuses \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "availabilityStatusName": "example", "awrSpecific": true, "displayInWorkerApp": true, "displayTextInWorkerApp": "example" }'

Creates an availability status for your agency. An availability status marks what a worker is doing on a given day — available, on holiday, at the doctor, on paternity leave.

The name must not already be in use by another of your agency’s records; a clash returns 400 rather than creating a duplicate.

Returns 201 with the created record.

You only ever see and change your own agency’s records; there is no owner id on the request, and an id belonging to another agency returns 404 rather than 403 so that its existence is never disclosed.

Access. Requires a client-credentials access token. Tokens issued through the interactive user login are rejected.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
availabilityStatusName
string
awrSpecific

Whether AWR-specific breaks are applied to this status when a worker’s parity is calculated. The flag on its own is not enough: the status name must also be one of SICKNESS, JURY_SERVICE, MATERNITY, PATERNITY, ADOPTION or UNPAID_LEAVE, in upper case.

boolean
displayInWorkerApp

Whether this status is offered to workers in the Recruso Worker App, where a worker sets their own availability.

boolean
displayTextInWorkerApp
string
nullable
Examplegenerated
{
  "availabilityStatusName": "example",
  "awrSpecific": true,
  "displayInWorkerApp": true,
  "displayTextInWorkerApp": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
availabilityStatusId
integer format: int16
availabilityStatusName
string
awrSpecific

Whether AWR-specific breaks are applied to this status when a worker’s parity is calculated. The flag on its own is not enough: the status name must also be one of SICKNESS, JURY_SERVICE, MATERNITY, PATERNITY, ADOPTION or UNPAID_LEAVE, in upper case.

boolean
displayInWorkerApp

Whether this status is offered to workers in the Recruso Worker App, where a worker sets their own availability.

boolean
displayTextInWorkerApp
string
nullable
Examplegenerated
{
  "availabilityStatusId": 1,
  "availabilityStatusName": "example",
  "awrSpecific": true,
  "displayInWorkerApp": true,
  "displayTextInWorkerApp": "example"
}

400

Section titled “400”

Bad Request

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}