---
title: "Update a contact"
method: PATCH
path: "/v1/contacts/{contactId}"
tags: ["Contacts"]
---

# Update a contact

`PATCH /v1/contacts/{contactId}`

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

## Path parameters

- `contactId` integer, required

## Headers

- `Customer-Id` integer, required

## Request body

- UpdateContactModel — Update contact model. At least one optional value must be provided. The API doesn't currently support polygon information for a contact. If the contact has been set up with polygon information in JobWatch, updating the location here will overwrite the polygon data and revert to a circle. To avoid unintentional updates, very small changes to the location are ignored by this endpoint
  - `reference` string, nullable — The internal reference of the contact - should usually be unique<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `name` string — The name of the contact<br/><br/>Optional: Omit to retain current value
  - `groupId` integer — The unique identifier of the group this contact belongs to<br/><br/>Optional: Omit to retain current value
  - `parentId` integer, nullable — The unique identifier of the parent contact of this contact<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `extraInformation` string, nullable — A free text description about the contact<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `street` string, nullable — The contact street address<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `town` string, nullable — The contact address town / city / village / locality<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `postalCode` string, nullable — The contact address postcode or zipcode<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `country` string, nullable — The textual name of the contact address country<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `location` Location — Represents a geographical location
    - `latitude` number, double, required — Latitude of the center of the location
    - `longitude` number, double, required — Longitude of the center of the location
  - `customFields` CustomFieldWriteModel[] — Custom fields associated with the contact. 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)