contacts

Update /contacts/{uuid}

Update a contact person by UUID (PATCH). Only sent fields are updated. When clients is sent, it replaces the full linked-client list. Returns record with the detail projection.

PATCH

/contacts/{uuid}

curl --request PATCH \
  --url https://default.hannacrm.app/api/v4/contacts/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clients": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "custom_fields": [
    {
      "slug": "<string>",
      "value": "<any>"
    }
  ],
  "email": "<string>",
  "firstname": "<string>",
  "is_primary": "<string>",
  "lastname": "<string>",
  "phone": "<string>",
  "position_title": "<string>"
}
'

{
  "record": {
    "clients": [
      {}
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "custom_fields": [
      {
        "slug": "<string>",
        "value": "<any>"
      }
    ],
    "datecreated": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "firstname": "<string>",
    "is_primary": "<string>",
    "lastname": "<string>",
    "phone": "<string>",
    "position_title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "uuid": "<string>"
  }
}

Authorizations

Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

Body

clientsstring[]

Linked client UUIDs. At least one is required on create. On update, replaces the full linked-client list when sent. The first UUID is stored as the primary legacy client link.

custom_fieldsobject[]

Custom field values by slug.

Show child attributes

emailstring

Email address.

firstnamestring

First name.

is_primarystring

Whether this person is the primary contact for the linked client(s).

lastnamestring

Last name.

phonestring

Phone number.

position_titlestring

Job title / position.

Fields enabled for this documentation instance (projection enabled: feature, option, subdomain, closures) plus account-level form field visibility. Role- and user-level field overrides are not applied here, so an API key whose staff user has such overrides may receive fewer fields. A disabled field is omitted from the response object entirely; a present key with a null value means the record simply has no value.

Show child attributes

Still need help? Ask the team

Update /contacts/{uuid}

Authorizations

Path Parameters

Body

Response