Skip to content

Update a job category

PUT
/v1/job-categories/{id}
curl --request PUT \
--url https://api2.recruso.co.uk/v1/job-categories/1 \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "id": 1, "jobCategoryName": "example", "displayInSelfRegistration": true }'

Updates one of your agency’s job categories. A job category is a skill a worker can be recorded as having.

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.

id
required
integer format: int32

The id path parameter

Media typeapplication/json
object
id
integer format: int32
jobCategoryName
string
displayInSelfRegistration

Whether this job category appears in Recruso’s separate worker self-registration service. Your agency chooses which skills a self-registering worker is offered.

boolean
nullable
Examplegenerated
{
"id": 1,
"jobCategoryName": "example",
"displayInSelfRegistration": true
}

OK

Media typeapplication/json
object
jobCategoryId
integer format: int32
jobCategoryName
string
displayInSelfRegistration

Whether this job category appears in Recruso’s separate worker self-registration service. Your agency chooses which skills a self-registering worker is offered.

boolean
nullable
Examplegenerated
{
"jobCategoryId": 1,
"jobCategoryName": "example",
"displayInSelfRegistration": true
}

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

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

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

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