Partially update worker

PATCH

/v1/workers/{id}

Maintainer:Not configured

Alias of PUT. All fields are optional.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Example

{
    "is_active": false
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/v1/workers/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "is_active": false
}'

Responses

🟢200

application/json

Updated worker record

Bodyapplication/json

Example

{
    "data": {
        "id": 101,
        "first_name": "Jane",
        "last_name": "Smith",
        "date_of_birth": "1985-06-15",
        "email": "jane.smith@example.com",
        "phone": "07700900123",
        "regulator": "nmc",
        "registration_number": "SW12345",
        "profession": "Social Worker",
        "current_status": "active",
        "expiry_date": "2027-06-30",
        "restrictions_summary": null,
        "monitoring_start_date": "2026-04-21",
        "check_frequency": "daily",
        "last_checked_at": "2026-04-21T08:30:00+00:00",
        "next_check_due_at": "2026-04-28T08:30:00+00:00",
        "consent_given": true,
        "consent_given_at": "2026-04-21T09:00:00+00:00",
        "is_active": true,
        "notes": "Senior social worker, team lead",
        "created_at": "2026-04-21T09:00:00+00:00",
        "updated_at": "2026-04-21T11:30:00+00:00"
    }
}

🟠401Unauthorized

🟠404NotFound

🟠422ValidationError

Modified at 2026-04-24 12:59:02

Update worker

Delete worker