Patch a CRM Person - Zeeg Developer Hub

PATCH

crm

people

{id}

Patch a CRM person

curl --request PATCH \
  --url https://api.zeeg.me/v2/crm/people/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "salutation": "<string>",
  "emails": [
    "jsmith@example.com"
  ],
  "jobTitle": "<string>",
  "description": "<string>",
  "phoneNumber": "<string>",
  "primaryLocation": "<string>",
  "avatarUrl": "<string>",
  "companyId": "<string>",
  "socials": {
    "linkedin": "<string>",
    "twitter": "<string>",
    "facebook": "<string>",
    "instagram": "<string>"
  }
}
'

{
  "success": true,
  "status": 200,
  "person": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "firstName": "Jane",
    "lastName": "Doe",
    "salutation": "Ms",
    "emails": [
      "jane.doe@acme.com"
    ],
    "jobTitle": "Head of Product",
    "description": "Key decision-maker at Acme Corp.",
    "phoneNumber": "+4930123456789",
    "primaryLocation": "Berlin, Germany",
    "avatarUrl": null,
    "company": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "domain": "<string>"
    },
    "socials": {
      "linkedin": "https://linkedin.com/in/janedoe",
      "twitter": null,
      "facebook": null,
      "instagram": null
    },
    "customAttributes": {},
    "createdAt": "2025-01-15T09:00:00+00:00",
    "updatedAt": "2025-06-01T12:00:00+00:00"
  }
}

Partially updates a CRM person record. Only fields you include in the request body are changed — omitted fields keep their current values. To update individual social links without overwriting the others, include only the keys you want to change inside socials:

{
  "socials": {
    "linkedin": "https://linkedin.com/in/updated"
  }
}

This updates linkedin only. twitter, facebook, and instagram are unchanged.

Authorizations

Authorization

string

header

required

Path Parameters

string<uuid>

required

UUID of the person record to update.

Body

application/json

firstName

string | null

lastName

string | null

salutation

string | null

emails

string<email>[] | null

jobTitle

string | null

description

string | null

phoneNumber

string | null

primaryLocation

string | null

avatarUrl

string | null

companyId

string | null

socials

object

Hide child attributes

socials.linkedin

string | null

socials.twitter

string | null

socials.facebook

string | null

socials.instagram

string | null

Response

success

boolean

Example:

true

status

integer

Example:

200

person

object

A CRM person record.

Hide child attributes

person.id

string<uuid>

required

Unique identifier for the person record.

Example:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

person.firstName

string | null

required

First name.

Example:

"Jane"

person.lastName

string | null

required

Last name.

Example:

"Doe"

person.salutation

string | null

required

Salutation or title (e.g. Mr, Ms, Dr).

Example:

"Ms"

person.emails

string<email>[]

required

List of email addresses. The first entry is the primary email.

Example:

["jane.doe@acme.com"]

person.jobTitle

string | null

required

Job title or role.

Example:

"Head of Product"

person.description

string | null

required

Free-text description or notes about the person.

Example:

"Key decision-maker at Acme Corp."

person.phoneNumber

string | null

required

Primary phone number.

Example:

"+4930123456789"

person.primaryLocation

string | null

required

Primary location or city.

Example:

"Berlin, Germany"

person.avatarUrl

string | null

required

URL of the person's avatar image.

Example:

null

person.company

object

required

The company this person is associated with, if any.

Hide child attributes

person.company.id

string<uuid>

person.company.name

string | null

person.company.domain

string | null

person.socials

object

required

Social profile links.

Hide child attributes

person.socials.linkedin

string | null

Example:

"https://linkedin.com/in/janedoe"

person.socials.twitter

string | null

Example:

null

person.socials.facebook

string | null

Example:

null

person.socials.instagram

string | null

Example:

null

person.customAttributes

object

required

Key/value pairs for custom attributes defined on the people object.

Example:

{}

person.createdAt

string<date-time>

required

ISO 8601 timestamp when the record was created.

Example:

"2025-01-15T09:00:00+00:00"

person.updatedAt

string<date-time>

required

ISO 8601 timestamp when the record was last updated.

Example:

"2025-06-01T12:00:00+00:00"

Last modified on May 7, 2026

Assert a CRM Person

Delete a CRM Person

Patch a CRM person

curl --request PATCH \
  --url https://api.zeeg.me/v2/crm/people/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "salutation": "<string>",
  "emails": [
    "jsmith@example.com"
  ],
  "jobTitle": "<string>",
  "description": "<string>",
  "phoneNumber": "<string>",
  "primaryLocation": "<string>",
  "avatarUrl": "<string>",
  "companyId": "<string>",
  "socials": {
    "linkedin": "<string>",
    "twitter": "<string>",
    "facebook": "<string>",
    "instagram": "<string>"
  }
}
'

{
  "success": true,
  "status": 200,
  "person": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "firstName": "Jane",
    "lastName": "Doe",
    "salutation": "Ms",
    "emails": [
      "jane.doe@acme.com"
    ],
    "jobTitle": "Head of Product",
    "description": "Key decision-maker at Acme Corp.",
    "phoneNumber": "+4930123456789",
    "primaryLocation": "Berlin, Germany",
    "avatarUrl": null,
    "company": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "domain": "<string>"
    },
    "socials": {
      "linkedin": "https://linkedin.com/in/janedoe",
      "twitter": null,
      "facebook": null,
      "instagram": null
    },
    "customAttributes": {},
    "createdAt": "2025-01-15T09:00:00+00:00",
    "updatedAt": "2025-06-01T12:00:00+00:00"
  }
}

Documentation Index

​Social links

Authorizations

Path Parameters

Body

Response

Social links