---
title: "Update a person"
method: PATCH
path: "/v1/persons/{personId}"
tags: ["Persons"]
---

# Update a person

`PATCH /v1/persons/{personId}`

Update the details of a single person (required scope contacts:persons:write)

## Path parameters

- `personId` string, uuid, required

## Headers

- `Customer-Id` integer, required

## Request body

- UpdatePersonModel — Update person model. At least one optional value must be provided
  - `title` string, nullable — The person's title<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `forename` string — The person's first name<br/><br/>Optional: Omit to retain current value
  - `surname` string — The person's second name<br/><br/>Optional: Omit to retain current value
  - `email` string — The email address of the person, provide an empty string to unset.<br/><br/>Optional: Omit to retain current value
  - `mobile` string, nullable — The mobile telephone number of the person<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `landline` string, nullable — The landline telephone number of the person<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `extension` string, nullable — The landline extension of the person<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `position` string, nullable — The job role that the person holds within the contact<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `department` string, nullable — The department that the person belongs to<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `isOptedOut` boolean — A flag indicating if the contact has opted out of marketing communications<br/><br/>Optional: Omit to retain current value
  - `customFields` CustomFieldWriteModel[] — Custom fields associated with the person. Omit or use an empty list to retain current values<br/><br/>Optional: Omit to retain current value
    - `definitionId` integer, required — The unique identifier of the associated custom field definition
    - `value` string, nullable — The value of this custom field. If set to null, any existing value will be unset

## Response `204`

No Content

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Content
- `500` — Internal Server Error

---

[API](https://skmtc.net/bigchange/apis/bigchange-dx.md) · [All operations](https://skmtc.net/bigchange/apis/bigchange-dx/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigchange/bigchange-dx/revisions/916e669fc527/schema)