> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.a1.uk.astutepayroll.in/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.a1.uk.astutepayroll.in/_mcp/server. # Update Employee Personal Details PATCH {{baseUrl}}/employees/personal-details/{uuid} Content-Type: application/json Update an employee's personal details. Reference: https://docs.a1.uk.astutepayroll.in/api-reference/employee/update-employee-personal-details ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `uuid` (string, required) — User id of the employee to update (not a UUID) ### Headers - `vnd.a1.tenant-id` (string, optional) — Tenant identifier for multi-tenant environments ### Body (application/json) This endpoint expects a PersonalDetailsPatch. - `nameTitle` (string, optional) - `nameFirst` (string, optional) - `nameLast` (string, optional) - `nameMiddle` (string, optional) - `nameKnownAs` (string, optional) - `dateOfBirth` (date, optional) - `gender` (enum, optional) - Allowed values: `MALE`, `FEMALE`, `NOT_STATED` - `maritalStatus` (enum, optional) - Allowed values: `SINGLE`, `MARRIED`, `DIVORCED`, `WIDOWED`, `CIVIL_PARTNERSHIP`, `UNKNOWN` - `nationality` (string, optional) - `contact` (PersonalDetailsPatchContact, optional) — Contact details. Replaced as a whole, so send every field; missing ones are cleared. - `postalAddress` (PersonalDetailsPatchPostalAddress, optional) — Employee postal address. Replaced as a whole, so send every field; missing ones are cleared. - `emergencyContact` (PersonalDetailsPatchEmergencyContact, optional) — Emergency contact details. Replaced as a whole, so send every field; missing ones are cleared. ## Response ### 200 Personal details updated successfully - `id` (string, optional) — User id of the employee (not a UUID) ## Errors ### 400 Bad Request Error Bad Request - `any` ### 404 Not Found Error Employee not found - `any` ## Types ### PersonalDetailsPatchContact Contact details. Replaced as a whole, so send every field; missing ones are cleared. - `primaryEmail` (string, required) - `payslipEmail` (string, required) — Send an empty string when there is no payslip email. - `phone` (PersonalDetailsPatchContactPhone, required) - `mobile` (PersonalDetailsPatchContactMobile, required) - `emailPayslip` (boolean, optional) - `sendNotification` (boolean, optional) - `pdfPasswordType` (enum, optional) — Required when emailPayslip is true - Allowed values: `CUSTOM`, `DATE_OF_BIRTH`, `NATIONAL_INSURANCE_NUMBER` - `pdfPassword` (string, optional) — Required when emailPayslip is true and pdfPasswordType is CUSTOM ### PersonalDetailsPatchPostalAddress Employee postal address. Replaced as a whole, so send every field; missing ones are cleared. - `line1` (string, required) - `townCity` (string, required) - `country` (string, required) — UK country code (e.g. England, Scotland, Wales, NorthernIreland, OutsideUK) - `postcode` (string, required) - `line2` (string, optional) - `foreignCountry` (string, optional) — Required when country is OutsideUK - `state` (string, optional) ### PersonalDetailsPatchEmergencyContact Emergency contact details. Replaced as a whole, so send every field; missing ones are cleared. - `fullName` (string, required) - `relationship` (string, required) - `phone` (PersonalDetailsPatchEmergencyContactPhone, required) - `email` (string, optional) ### PersonalDetailsPatchContactPhone - `countryCode` (string, optional) - `number` (string, optional) ### PersonalDetailsPatchContactMobile - `countryCode` (string, optional) - `number` (string, optional) ### PersonalDetailsPatchEmergencyContactPhone - `countryCode` (string, optional) - `number` (string, optional) ## Examples **Request** ```json { "nameTitle": "Mr", "nameFirst": "Jane", "nameLast": "Smith", "nameMiddle": "A", "nameKnownAs": "Jane", "dateOfBirth": "2004-02-01", "gender": "FEMALE", "maritalStatus": "SINGLE", "nationality": "British", "contact": { "primaryEmail": "jane.smith@example.com", "payslipEmail": "", "phone": { "countryCode": "44", "number": "1234567890" }, "mobile": { "countryCode": "44", "number": "7700123456" }, "emailPayslip": false } } ``` **Response** ```json { "id": "axgZDy2kxi6mbvC9sNDL5dMs" } ``` **SDK Code** ```python import requests url = "https://{{baseurl}}/employees/personal-details/axgZDy2kxi6mbvC9sNDL5dMs" payload = { "nameTitle": "Mr", "nameFirst": "Jane", "nameLast": "Smith", "nameMiddle": "A", "nameKnownAs": "Jane", "dateOfBirth": "2004-02-01", "gender": "FEMALE", "maritalStatus": "SINGLE", "nationality": "British", "contact": { "primaryEmail": "jane.smith@example.com", "payslipEmail": "", "phone": { "countryCode": "44", "number": "1234567890" }, "mobile": { "countryCode": "44", "number": "7700123456" }, "emailPayslip": False } } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://{{baseurl}}/employees/personal-details/axgZDy2kxi6mbvC9sNDL5dMs'; const options = { method: 'PATCH', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"nameTitle":"Mr","nameFirst":"Jane","nameLast":"Smith","nameMiddle":"A","nameKnownAs":"Jane","dateOfBirth":"2004-02-01","gender":"FEMALE","maritalStatus":"SINGLE","nationality":"British","contact":{"primaryEmail":"jane.smith@example.com","payslipEmail":"","phone":{"countryCode":"44","number":"1234567890"},"mobile":{"countryCode":"44","number":"7700123456"},"emailPayslip":false}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://{{baseurl}}/employees/personal-details/axgZDy2kxi6mbvC9sNDL5dMs" payload := strings.NewReader("{\n \"nameTitle\": \"Mr\",\n \"nameFirst\": \"Jane\",\n \"nameLast\": \"Smith\",\n \"nameMiddle\": \"A\",\n \"nameKnownAs\": \"Jane\",\n \"dateOfBirth\": \"2004-02-01\",\n \"gender\": \"FEMALE\",\n \"maritalStatus\": \"SINGLE\",\n \"nationality\": \"British\",\n \"contact\": {\n \"primaryEmail\": \"jane.smith@example.com\",\n \"payslipEmail\": \"\",\n \"phone\": {\n \"countryCode\": \"44\",\n \"number\": \"1234567890\"\n },\n \"mobile\": {\n \"countryCode\": \"44\",\n \"number\": \"7700123456\"\n },\n \"emailPayslip\": false\n }\n}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://{{baseurl}}/employees/personal-details/axgZDy2kxi6mbvC9sNDL5dMs") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"nameTitle\": \"Mr\",\n \"nameFirst\": \"Jane\",\n \"nameLast\": \"Smith\",\n \"nameMiddle\": \"A\",\n \"nameKnownAs\": \"Jane\",\n \"dateOfBirth\": \"2004-02-01\",\n \"gender\": \"FEMALE\",\n \"maritalStatus\": \"SINGLE\",\n \"nationality\": \"British\",\n \"contact\": {\n \"primaryEmail\": \"jane.smith@example.com\",\n \"payslipEmail\": \"\",\n \"phone\": {\n \"countryCode\": \"44\",\n \"number\": \"1234567890\"\n },\n \"mobile\": {\n \"countryCode\": \"44\",\n \"number\": \"7700123456\"\n },\n \"emailPayslip\": false\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://{{baseurl}}/employees/personal-details/axgZDy2kxi6mbvC9sNDL5dMs") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"nameTitle\": \"Mr\",\n \"nameFirst\": \"Jane\",\n \"nameLast\": \"Smith\",\n \"nameMiddle\": \"A\",\n \"nameKnownAs\": \"Jane\",\n \"dateOfBirth\": \"2004-02-01\",\n \"gender\": \"FEMALE\",\n \"maritalStatus\": \"SINGLE\",\n \"nationality\": \"British\",\n \"contact\": {\n \"primaryEmail\": \"jane.smith@example.com\",\n \"payslipEmail\": \"\",\n \"phone\": {\n \"countryCode\": \"44\",\n \"number\": \"1234567890\"\n },\n \"mobile\": {\n \"countryCode\": \"44\",\n \"number\": \"7700123456\"\n },\n \"emailPayslip\": false\n }\n}") .asString(); ``` ```php request('PATCH', 'https://{{baseurl}}/employees/personal-details/axgZDy2kxi6mbvC9sNDL5dMs', [ 'body' => '{ "nameTitle": "Mr", "nameFirst": "Jane", "nameLast": "Smith", "nameMiddle": "A", "nameKnownAs": "Jane", "dateOfBirth": "2004-02-01", "gender": "FEMALE", "maritalStatus": "SINGLE", "nationality": "British", "contact": { "primaryEmail": "jane.smith@example.com", "payslipEmail": "", "phone": { "countryCode": "44", "number": "1234567890" }, "mobile": { "countryCode": "44", "number": "7700123456" }, "emailPayslip": false } }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://{{baseurl}}/employees/personal-details/axgZDy2kxi6mbvC9sNDL5dMs"); var request = new RestRequest(Method.PATCH); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"nameTitle\": \"Mr\",\n \"nameFirst\": \"Jane\",\n \"nameLast\": \"Smith\",\n \"nameMiddle\": \"A\",\n \"nameKnownAs\": \"Jane\",\n \"dateOfBirth\": \"2004-02-01\",\n \"gender\": \"FEMALE\",\n \"maritalStatus\": \"SINGLE\",\n \"nationality\": \"British\",\n \"contact\": {\n \"primaryEmail\": \"jane.smith@example.com\",\n \"payslipEmail\": \"\",\n \"phone\": {\n \"countryCode\": \"44\",\n \"number\": \"1234567890\"\n },\n \"mobile\": {\n \"countryCode\": \"44\",\n \"number\": \"7700123456\"\n },\n \"emailPayslip\": false\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "nameTitle": "Mr", "nameFirst": "Jane", "nameLast": "Smith", "nameMiddle": "A", "nameKnownAs": "Jane", "dateOfBirth": "2004-02-01", "gender": "FEMALE", "maritalStatus": "SINGLE", "nationality": "British", "contact": [ "primaryEmail": "jane.smith@example.com", "payslipEmail": "", "phone": [ "countryCode": "44", "number": "1234567890" ], "mobile": [ "countryCode": "44", "number": "7700123456" ], "emailPayslip": false ] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://{{baseurl}}/employees/personal-details/axgZDy2kxi6mbvC9sNDL5dMs")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```