Skip to content

Update user

Request

Partially updates a user. Only the fields present in the request body are changed; omitted fields are left untouched. role is restricted to carer, senior-carer, carehome-admin, and management.

customId: omit to leave it unchanged, send a string to set it, or send null to unset it.

home and every entry in homes must be within the API key's home scope, or the request is rejected with 403. If either home or homes is supplied, the resulting homes (the new one if supplied, otherwise the existing one) must include the resulting primary home (the new home if supplied, otherwise the existing one), or the request is rejected with 400.

Security
bearer
Path
idstringrequired

Unique identifier of the user

Example:64f8a1b23d4e5f6a7b8c9d0e
Bodyapplication/jsonrequired
nameobject(UserNameDto)
emailstring
Example:"jane.smith@sunrisecare.co.uk"
rolestring
Enum:"carer""senior-carer""carehome-admin""management"
activeboolean
Example:true
externalSourceobject(ExternalSourceDto)
homestring

Primary home ID. Must be a home the API key is authorized for, or the request is rejected with 403.

Example:"507f1f77bcf86cd799439011"
homesArray of strings

Home IDs this user belongs to. Every ID must be a home the API key is authorized for (403 otherwise), and the list must include the primary home — the new one if supplied, otherwise the existing one (400 otherwise).

Example:
[]
customIdstring or null

Caller-defined identifier for this user. Omit to leave the stored value unchanged, set a string to update it, or send null to unset it.

Example:"EMP-00123"
curl -i -X PUT \
  https://data.logmycare.co.uk/openapi/api/users/64f8a1b23d4e5f6a7b8c9d0e \
  -H 'Content-Type: application/json' \
  -d '{
    "name": {
      "first": "Jane",
      "last": "Smith"
    },
    "email": "jane.smith@sunrisecare.co.uk",
    "role": "carer",
    "active": true,
    "externalSource": {
      "sourceName": "my-integration",
      "sourceId": "ext-12345",
      "sourceType": "api",
      "externalCreatedAt": "2024-01-15T09:30:00.000Z",
      "sourceRecordUrl": "https://app.example.com/residents/ext-12345",
      "metadata": {
        "region": "north",
        "ward": "A"
      }
    },
    "home": "507f1f77bcf86cd799439011",
    "homes": [],
    "customId": "EMP-00123"
  }'

Responses

Successfully updated user

Bodyapplication/json
any
Response
{
  "id": "68406c31e55ca6b6d2262f56",
  "name": {
    "first": "Jane",
    "last": "Smith",
    "full": "Jane Smith"
  },
  "email": "jane.smith@example.co.uk",
  "role": "carehome-admin",
  "cernerRole": "standard",
  "active": true,
  "deleted": false,
  "dateOfBirth": "1985-03-22T00:00:00.000Z",
  "startDate": "2026-01-02T00:00:00.000Z",
  "endDate": null,
  "createdOn": "2026-01-15T09:00:00.000Z",
  "lastSeen": "2026-02-10T16:45:00.000Z",
  "firstLogin": "2026-01-15T09:18:06.809Z",
  "phoneNumber": "+44 7700 900789",
  "address": {
    "name": "",
    "number": "10",
    "street1": "Example Road",
    "street2": "",
    "suburb": "York",
    "state": "",
    "postcode": "EX1 1AB"
  },
  "allergies": "None",
  "hasAllergies": "no",
  "home": "5a1174a35dcb0e004030a28d",
  "homes": [
    "5a1174a35dcb0e004030a28d"
  ],
  "permissions": [
    "residents:read",
    "logs:read"
  ],
  "permissionsTemplate": "care-home-admin",
  "medicationPermission": true,
  "gpConnectPermission": false,
  "zones": [
    "Oak Wing"
  ],
  "allZones": false,
  "workProfile": {
    "contractType": "fullTime",
    "contractedHoursPerWeek": 37.5,
    "contractNotes": "",
    "rotaPreferenceNotes": "Prefers day shifts",
    "canDoOvertime": true,
    "availableTransportation": [ … ],
    "availability": {}
  },
  "hasRequestedDemo": false,
  "picture": "https://lmc-care-uploads.s3.eu-west-2.amazonaws.com/photos/users/example-user-id/avatar.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=EXAMPLE%2F20260115%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20260115T090000Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=examplesignature",
  "summary": "Experienced care home administrator.",
  "customId": "example-admin-id-123",
  "resident": null,
  "emergencyContactName": {
    "first": "John",
    "last": "Smith"
  },
  "emergencyContactRelation": "Spouse",
  "emergencyContactNumber": "+44 7700 900999"
}