---
title: "Update a client"
method: PATCH
path: "/clients/{id}"
tags: ["Clients"]
---

# Update a client

`PATCH /clients/{id}`

## Request

- Base URL: `https://api.heffl.com/api/v1`
- URL: `https://api.heffl.com/api/v1/clients/{id}`
- Auth: API key in header `x-api-key`

Updates an existing client/company in your CRM. Only provided fields will be updated.

## Path parameters

- `id` string, required: Client public ID

## Request body

- object
  - `type` 'company' | 'contact': Client type: company for companies, contact for contacts
  - `name` string: Company name (required for companies, optional for contacts)
  - `firstName` string: First name (required for contacts, optional for companies)
  - `lastName` string: Last name (optional for contacts)
  - `salutation` string: Title (Mr., Mrs., Dr., etc.)
  - `phone` string: Phone number with country code
  - `email` string, email, nullable: Email address
  - `jobTitle` string: Job title or position
  - `website` unknown
  - `taxNumber` string, nullable: Tax ID or VAT number
  - `billingAddress` object, nullable: Billing address details
    - `city` string, nullable: City
    - `address` string, nullable: Street address
    - `landmark` string, nullable: Nearby landmark
    - `state` string, nullable: State or province
    - `country` string, nullable: Country code (2 letters, e.g., US, GB)
    - `postalCode` string, nullable: Postal code or ZIP code
  - `primaryContact` object: Optional primary contact for company records
    - `firstName` string, required
    - `lastName` string
    - `email` string, email, nullable
    - `phone` string
    - `salutation` string
    - `jobTitle` string

## Response `200`

OK

- object
  - `id` string, required: Client public ID
  - `number` string, required: Auto-generated client number
  - `name` string, required: Client name
  - `type` 'company' | 'contact', required: Client type
  - `firstName` string, nullable: First name (for contacts)
  - `lastName` string, nullable: Last name (for contacts)
  - `email` string, nullable: Email address
  - `phone` string, nullable: Phone number
  - `website` string, nullable: Website URL
  - `stageId` string, nullable: Client stage public ID
  - `createdAt` string, date-time, required: When the client was created
  - `customFields` object, nullable: Custom field values

---

[API](https://skmtc.dev/heffl/apis/heffl-public-api-legacy-v1.md) · [All operations](https://skmtc.dev/heffl/apis/heffl-public-api-legacy-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/heffl/apis/heffl-public-api-legacy-v1/revisions/9bdb229223a2?raw)