Users

Updates a User

patch/api/v2/partner/users/{id}

Request

  • Base URL: http://localhost:5100
  • URL: http://localhost:5100/api/v2/partner/users/{id}
  • Auth: API key in header Authorization

Path parameters

idstring required

Partner User Identifier

Query parameters

client_idstring required

Partner Client ID

actor_identifierstring required

Partner User Identifier of the actor performing the action

Request body

emailstring

User email

first_namestring

User first name

last_namestring

User last name

probation_end_datestring date

Probation end date

termination_datestring date

Termination date

hours_per_weeknumber

Hours per week

annual_gross_salarynumber

Annual gross salary

ni_numberstring

National Insurance Number

pay_frequency'Monthly' | 'Weekly' | '2-weekly' | '4-weekly'

Pay frequency

employee_numberstring

Employee number

rolesstring[]

User roles

Response

User updated successfully

successboolean

Example response

{
  "success": true,
  "user": {
    "email": "user@example.com",
    "first_name": "Updated John",
    "last_name": "Updated Doe",
    "hours_per_week": "40.0",
    "annual_gross_salary": "50000.0",
    "ni_number": "AB123456C",
    "pay_frequency": "Monthly",
    "employee_number": "EMP001",
    "roles": [
      "user"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.