Patch Entity

​

Partially update an existing entity (PATCH).

Send only the fields to change. Every field is optional; a field that is omitted is not written and keeps its stored value. Values that are sent are validated the same way PUT validates them, so a field sent as null is cleared only where PUT also accepts null for it.

Args: entity_id: Unique identifier of the entity to update entity_info: The fields to change, plus custom field updates if applicable user: Authenticated user information (used for audit trails) response: HTTP response object for status code modification

Returns: Complete updated entity data, as PUT returns it

Note: - Returns HTTP 200 on successful update - Returns HTTP 206 (Partial Content) if entity is updated but some custom fields failed to update - Automatically updates modification timestamp and user information

Raises: HTTPException: - 400: Invalid input data - 401: Authentication required - 403: Insufficient permissions to update this entity - 404: Entity not found - 405: This service replaced the generic PUT with its own update handler, so the generic PATCH would bypass that handler's rules - 409: Update conflict - 422: Validation error in a sent field - 500: Internal server error during update

Path Parameters

  • entity_id
    Type: string
    required

Query Parameters

  • include_additionals
    Type: boolean

    Whether to include additional fields from the additional fields tab.

Body·

required
application/json
  • address
    Type: string
    max length:  
    256    nullable

    Address - Physical address or location

  • companyId
    Type: string
    min length:  
    2
    max length:  
    50    nullable

    Company ID - ID of the company this person is associated with. Must be a valid company ID starting with 'c-'

  • deskPhone
    Type: string
    max length:  
    100    nullable

    Desk Phone - Direct office phone number

  • email
    Type: string
    max length:  
    256    nullable

    Email Address - Primary email address. Can contain multiple emails separated by semicolons

  • firstName
    Type: string
    max length:  
    256    nullable

    First Name - Contact's first name

  • jobFunction
    Type: integernullable

    Job Function ID - Standardized job function category (e.g., Engineering, Sales, Marketing)

  • jobTitle
    Type: string
    max length:  
    256    nullable

    Job Title - Person's current job title or position

  • lastName
    Type: string
    max length:  
    256    nullable

    Last Name - Contact's last name

  • notes
    Type: string
    max length:  
    8192    nullable

    Notes - Free-form notes about the person, their preferences, or important context

  • phone
    Type: string
    max length:  
    256    nullable

    Phone Number - Primary phone number for the contact

  • referenceability
    Type: enumnullable

    Referenceability - Willingness and ability to serve as a customer reference

    values
    1234
  • reportsTo
    Type: string
    min length:  
    2
    max length:  
    50    nullable

    Reports To - ID of the person this contact reports to in their organization. Must be a valid person ID starting with 'p-'

  • propertyName
    additionalPropertyType: anything

Responses

  • application/json
  • application/json
  • application/json
Request Example for patch/{entity_id}
curl 'https://crm.dreamhub.ai/api/v1/people/{entity_id}?include_additionals=false' \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "firstName": "John",
  "lastName": "Smith",
  "companyId": "c-acme123",
  "jobTitle": "VP of Engineering",
  "phone": "+1-555-123-4567",
  "email": "john.smith@acme.com",
  "jobFunction": 1,
  "deskPhone": "+1-555-123-4567 ext. 123",
  "reportsTo": "p-manager123",
  "notes": "Prefers email communication",
  "address": "123 Main St, San Francisco, CA 94105",
  "referenceability": 1,
  "status": 1,
  "statusReasonText": "Left company",
  "statusChangedBy": "u-user123",
  "statusChangedAt": "2024-01-15T10:30:00Z",
  "additionalProperty": "anything"
}'

{
  "firstName": "John",
  "lastName": "Smith",
  "companyId": "c-acme123",
  "jobTitle": "VP of Engineering",
  "phone": "+1-555-123-4567",
  "email": "john.smith@acme.com",
  "jobFunction": 1,
  "deskPhone": "+1-555-123-4567 ext. 123",
  "reportsTo": "p-manager123",
  "notes": "Prefers email communication",
  "address": "123 Main St, San Francisco, CA 94105",
  "referenceability": 1,
  "status": 1,
  "statusReasonText": "Left company",
  "statusChangedBy": "u-user123",
  "statusChangedAt": "2024-01-15T10:30:00Z",
  "linkedinUrl": "https://www.linkedin.com/in/jane-doe",
  "lastModifiedBy": "string",
  "icpFit": 1,
  "icpMetadata": {
    "bullets": [
      {
        "status": "string",
        "primary": "string",
        "secondary": "string"
      }
    ]
  },
  "id": "p-jand-f47ac10b",
  "createdAt": "2026-11-12T20:58:52.149Z",
  "lastActivity": "2026-11-12T20:58:52.149Z",
  "emails": [
    "string"
  ],
  "fullName": "string",
  "companyName": "string",
  "reportsToFirstName": "string",
  "reportsToLastName": "string",
  "additionalProperty": "anything"
}

Successful Response

Previous
Update Entity
Next
Delete Entity