Update Entity

​

Update an existing entity (PUT).

The body is validated against the full input schema, so every field the schema marks as required must be present, even when its value does not change; a body missing one is rejected with 422. Optional fields that are omitted keep their stored values, and a field sent as null is cleared. To change only some fields without resending the required ones, use PATCH /{entity_id}.

Args: entity_id: Unique identifier of the entity to update entity_info: Entity data validated against the full input schema: - All required fields must be present - Omitted optional fields retain their current values - 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 including: - All entity fields with updated values - Updated timestamp information - Computed fields and relationships

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 or validation errors - 401: Authentication required - 403: Insufficient permissions to update this entity - 404: Entity not found - 409: Update conflict (entity modified by another user) - 422: Validation error in request data, including a missing required 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
  • name
    Type: string
    min length:  
    1
    max length:  
    256
    required

    Company Name - Official name of the company or organization

  • status
    Type: enum
    required

    Company Status - Current status of the company account (e.g., ACTIVE, INACTIVE, PROSPECT)

    values
    12345
  • 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

  • propertyName
    additionalPropertyType: anything

Responses

  • application/json
  • application/json
Request Example for put/{entity_id}
curl 'https://crm.dreamhub.ai/api/v1/companies/{entity_id}?include_additionals=false' \
  --request PUT \
  --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.707Z",
  "icpFit": 1,
  "icpMetadata": {
    "bullets": [
      {
        "status": "string",
        "primary": "string",
        "secondary": "string"
      }
    ]
  },
  "id": "c-log-f47ac10b",
  "createdAt": "2026-11-12T20:58:36.707Z",
  "lastActivity": "2026-11-12T20:58:36.707Z",
  "domainList": [
    "string"
  ],
  "industryName": "string",
  "subIndustryName": "string",
  "parentCompanyName": "string",
  "closestContractEndDate": "2026-11-12T20:58:36.708Z",
  "additionalProperty": "anything"
}

Successful Response

Previous
Get Entity By Id
Next
Patch Entity