Update Personal Details

Updates the personal details for the employee

Request

PUT https://api.yourpayroll.co.uk/api/v2/ess/{employeeId}/personaldetails

Path parameters

Parameter name Value Description Additional
employeeId string Required

Request body

The request body takes a complete UkEssEmployeeDetailsEditModel resource, containing the following writable properties:

{
    "dateOfBirth": "date-time",
    "email": "string",
    "firstName": "string",
    "gender": "string",
    "homePhone": "string",
    "id": "int32",
    "isPostalAddressSameAsResidential": "boolean",
    "middleName": "string",
    "mobilePhone": "string",
    "otherName": "string",
    "postalAddress": {
        "addressLine2": "string",
        "city": "string",
        "cityId": "int32",
        "country": "string",
        "countryId": "string",
        "county": "string",
        "isManualAddress": "boolean",
        "isOutOfRegion": "boolean",
        "postcode": "string",
        "streetAddress": "string"
    },
    "previousSurname": "string",
    "residentialAddress": {
        "addressLine2": "string",
        "city": "string",
        "cityId": "int32",
        "country": "string",
        "countryId": "string",
        "county": "string",
        "isManualAddress": "boolean",
        "isOutOfRegion": "boolean",
        "postcode": "string",
        "streetAddress": "string"
    },
    "surname": "string",
    "titleId": "int32",
    "workPhone": "string"
}

Properties

Name Type Description
dateOfBirth date-time Nullable
email string String
firstName string String
gender string String
homePhone string String
id int32 Int32
isPostalAddressSameAsResidential boolean Nullable
middleName string String
mobilePhone string String
otherName string String
postalAddress object UkAddressModel
postalAddress.addressLine2 string String
postalAddress.city string String
postalAddress.cityId int32 Nullable
postalAddress.country string String
postalAddress.countryId string String
postalAddress.county string String
postalAddress.isManualAddress boolean Nullable
postalAddress.isOutOfRegion boolean Nullable
postalAddress.postcode string String
postalAddress.streetAddress string String
previousSurname string String
residentialAddress object UkAddressModel
residentialAddress.addressLine2 string String
residentialAddress.city string String
residentialAddress.cityId int32 Nullable
residentialAddress.country string String
residentialAddress.countryId string String
residentialAddress.county string String
residentialAddress.isManualAddress boolean Nullable
residentialAddress.isOutOfRegion boolean Nullable
residentialAddress.postcode string String
residentialAddress.streetAddress string String
surname string String
titleId int32 Nullable
workPhone string String

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

 UkEssEmployeeDetailsViewModel