Skip to content
Recruso API

Update an AWR alert rule

PUT
/v1/awr-alert-rules/{id}
curl --request PUT \
  --url https://api2.recruso.co.uk/v1/awr-alert-rules/1 \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "weekThreshold": 1, "isActive": true }'

Updates one of your agency’s AWR alert rules. Under the Agency Workers Regulations a worker reaches parity in week 12, and these rules decide which of the weeks up to that point your agency is alerted in — a single week, or every week until parity is reached.

Send the complete record: the fields you supply replace the stored values.

The name must not already be in use by another of your agency’s records; a clash returns 400. The record’s own current name is allowed.

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”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
integer format: int32

The id path parameter

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
weekThreshold
required
integer format: uint8
isActive
required
boolean
Examplegenerated
{
  "weekThreshold": 1,
  "isActive": true
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
alertId
required
integer format: int32
weekThreshold
required
integer format: uint8
nullable
isActive
required
boolean
nullable
Examplegenerated
{
  "alertId": 1,
  "weekThreshold": 1,
  "isActive": true
}

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"
}

404

Section titled “404”

Not Found

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"
}