Skip to content

Create user

Request

Security
bearer
Bodyapplication/jsonrequired
nameobject(UserNameDto)required
emailstringrequired
Example:"jane.smith@sunrisecare.co.uk"
rolestringrequired
Enum:"carer""senior-carer""carehome-admin""management"
homestringrequired

Primary home ID

Example:"507f1f77bcf86cd799439011"
homesArray of strings
Example:
[]
externalSourceobject(ExternalSourceDto)
POST
/api/users
curl -i -X POST \
  https://data.logmycare.co.uk/openapi/api/users \
  -H 'Content-Type: application/json' \
  -d '{
    "name": {
      "first": "Jane",
      "last": "Smith"
    },
    "email": "jane.smith@sunrisecare.co.uk",
    "role": "carer",
    "home": "507f1f77bcf86cd799439011",
    "homes": [],
    "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"
      }
    }
  }'

Responses

Invalid query parameters

Bodyapplication/json
errorobject(ErrorDto)required

Error information

Response
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid date format",
    "details": { … },
    "timestamp": "2025-09-10T10:30:00Z",
    "correlationId": "req_12345"
  }
}