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 - Street address of the company's headquarters or primary location

  • aeOwner
    Type: stringnullable

    AE Owner - Account Executive responsible for this company. Must be a valid user ID starting with 'u-'

  • annualContractValue
    Type: numbernullable

    Annual Contract Value (ACV) - Total value of annual contracts with this company in USD

  • arr
    Type: numbernullable

    Annual Recurring Revenue (ARR) - Total annual recurring revenue from this company in USD

  • city
    Type: string
    max length:  
    256    nullable

    City - City where the company is headquartered or has primary operations

  • country
    Type: string
    max length:  
    256    nullable

    Country - Country where the company is headquartered or has primary operations

  • csmOwner
    Type: stringnullable

    CSM Owner - Customer Success Manager assigned to this company. Must be a valid user ID starting with 'u-'

  • domains
    Type: string
    max length:  
    256    nullable

    Domains - Semicolon-separated list of known company domains

  • fiscalYearStartsAt
    Type: stringFormat: date-timenullable

    Fiscal Year Start Date - When the company's fiscal year begins. Used for financial reporting and quota calculations

  • industryId
    Type: integernullable

    Industry ID - Primary industry classification for this company

  • linkedinUrl
    Type: string
    max length:  
    256    nullable

    LinkedIn - URL of the company's LinkedIn page

  • mrr
    Type: numbernullable

    Monthly Recurring Revenue (MRR) - Total monthly recurring revenue from this company in USD

  • propertyName
    additionalPropertyType: anything

Responses

  • application/json
  • application/json
  • application/json
Request Example for patch/{entity_id}
curl 'https://crm.dreamhub.ai/api/v1/companies/{entity_id}?include_additionals=false' \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "Acme Corporation",
  "status": 1,
  "sdrOwner": "u-sdr123",
  "aeOwner": "u-ae789",
  "csmOwner": "u-csm345",
  "industryId": 1,
  "subIndustryId": "si-tech",
  "city": "San Francisco",
  "stateRegion": "California",
  "country": "United States",
  "postalCode": "94105",
  "numOfEmployees": 50,
  "parentCompany": "c-parent123",
  "address": "123 Main Street",
  "fiscalYearStartsAt": "2024-01-01T00:00:00Z",
  "website": "https://www.acme.com",
  "linkedinUrl": "https://www.linkedin.com/company/acme",
  "domains": "",
  "phone": "+1-555-123-4567",
  "segment": 1,
  "arr": 120000,
  "mrr": 10000,
  "annualContractValue": 150000,
  "totalContractValue": 450000,
  "additionalProperty": "anything"
}'

{
  "name": "Acme Corporation",
  "status": 1,
  "sdrOwner": "u-sdr123",
  "aeOwner": "u-ae789",
  "csmOwner": "u-csm345",
  "industryId": 1,
  "subIndustryId": "si-tech",
  "city": "San Francisco",
  "stateRegion": "California",
  "country": "United States",
  "postalCode": "94105",
  "numOfEmployees": 50,
  "parentCompany": "c-parent123",
  "address": "123 Main Street",
  "fiscalYearStartsAt": "2024-01-01T00:00:00Z",
  "website": "https://www.acme.com",
  "linkedinUrl": "https://www.linkedin.com/company/acme",
  "domains": "string",
  "phone": "+1-555-123-4567",
  "segment": 1,
  "arr": 120000,
  "mrr": 10000,
  "annualContractValue": 150000,
  "totalContractValue": 450000,
  "lastModifiedBy": "string",
  "statusChangedAt": "2026-11-12T20:58:36.742Z",
  "icpFit": 1,
  "icpMetadata": {
    "bullets": [
      {
        "status": "string",
        "primary": "string",
        "secondary": "string"
      }
    ]
  },
  "id": "c-log-f47ac10b",
  "createdAt": "2026-11-12T20:58:36.743Z",
  "lastActivity": "2026-11-12T20:58:36.743Z",
  "domainList": [
    "string"
  ],
  "industryName": "string",
  "subIndustryName": "string",
  "parentCompanyName": "string",
  "closestContractEndDate": "2026-11-12T20:58:36.743Z",
  "additionalProperty": "anything"
}

Successful Response

Previous
Update Entity
Next
Delete Entity