# Update client **PUT /api/v2/clients/{ClientGUID}** Update a client record record. ## Servers - https://api.fincalc.co.uk: https://api.fincalc.co.uk () ## Authentication methods - Bearer auth ## Parameters #### Path parameters - **ClientGUID** (string(uuid)) The GUID of the client you want to update. ## Body parameters Content-type: application/json - **Title** (string | null) The following characters are not permitted: \\:*"<>| - **FirstName** (string) The following characters are not permitted: \\:*"<>| - **Surname** (string) The following characters are not permitted: \\:*"<>| - **KnownAs** (string | null) The following characters are not permitted: \\:*"<>| - **Gender** (integer) An integer representing the gender of the client: - 1: Male - 2: Female - 3: Other - **EmailAddress** (string(email) | null) If the client portal is enabled for this client then the email address cannot be removed and is required. - **Mobile** (string | null) - **DateOfBirth** (string(date)) Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023. The response will contain an object of formatted values where the date will in the format "d/m/Y". - **MaritalStatus** (integer | null) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options - **MarriageAllowance** (integer | null) An integer representing the status of the clients marriage allowance: - 1: Yes - 2: No - **NINumber** (string | null) - **EmploymentStatus** (integer | null) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options - **OccupationCode** (string | null) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options - **RetirementPlanned** (integer | null) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options This field is required if the value of EmploymentStatus = 1, 2, 3, 4 or 6. - **RetirementDate** (string(date) | null) This field is required if the value of EmploymentStatus = 1, 2, 3, 4 or 6 and the value of RetirementPlanned = 2. Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023. The response will contain an object of formatted values where the date will in the format "d/m/Y". - **RetirementAge** (integer | null) This field is required if the value of EmploymentStatus = 1, 2, 3, 4 or 6 and the value of RetirementPlanned = 1. - **AddressCountryCode** (integer | null) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options - **AddressLine1** (string | null) The following characters are not permitted: \\:*"<>| - **AddressLine2** (string | null) The following characters are not permitted: \\:*"<>| - **AddressLine3** (string | null) The following characters are not permitted: \\:*"<>| - **AddressLine4** (string | null) The following characters are not permitted: \\:*"<>| - **AddressTown** (string | null) The following characters are not permitted: \\:*"<>| - **AddressCounty** (string | null) - **AddressPostCode** (string | null) The following characters are not permitted: \\:*"<>| - **IncomeTaxArea** (integer | null) An integer representing the clients income tax area: - 1: UK excluding Scotland - 2: Scotland - 3: Other - 4: All at 20% - 5: No Tax Applied - **AdviserUserGUID** (string(uuid) | null) This field is required if the user company is different to primary company (user is logged into a network company) or if the company has had the adviser field enforced or if the client portal is enabled for the client that is being edited. To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options - **Reference** (string | null) - **ATRGUID** (string(uuid) | null) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options - **ClientTierGUID** (string(uuid) | null) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options - **FinancialDependenceAge** (integer | null) To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options - **AddressFrom** (string(date) | null) Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023. The response will contain an object of formatted values where the date will in the format "d/m/Y". - **NextReviewDate** (string(date) | null) Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023. The response will contain an object of formatted values where the date will in the format "d/m/Y". - **LTA** (object) - **ExcludeFormattedValues** (string | null) If set to any value, formatted values will be excluded from the response. ## Responses ### 200: Success #### Body Parameters: application/json (object) - **success** (boolean) - **data** (object) ### 422: Validation error #### Body Parameters: application/json (object) - **success** (boolean) - **message** (string) - **data** (object) Example validation error message. ### 403: Permission error. #### Body Parameters: application/json (object) - **success** (boolean) - **message** (string) ### 404: Client not found. #### Body Parameters: application/json (object) - **success** (boolean) - **message** (string) ### 500: Internal server error. #### Body Parameters: application/json (object) - **success** (boolean) - **message** (string) [Powered by Bump.sh](https://bump.sh)