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
  • aeOwner
    Type: string
    max length:  
    50    nullable

    AE Owner - Account Executive who will handle the lead if qualified. Must be a valid user ID starting with 'u-'

  • closedAsQualifiedReason
    Type: integernullable

    Qualification Reason - Why the lead was marked as qualified (required when status is CLOSED_QUALIFIED)

  • companyId
    Type: string
    max length:  
    50    nullable

    Company ID - Associated company for this lead. Must be a valid company ID starting with 'c-'

  • contactId
    Type: string
    max length:  
    50    nullable

    Contact ID - Primary contact person for this lead. Must be a valid person ID starting with 'p-'

  • conversionProbability
    Type: numbernullable

    Conversion Probability - Estimated likelihood of converting to a qualified opportunity (0.0 to 1.0)

  • createdAt
    Type: stringFormat: date-timenullable

    Creation Date - When the lead was first created in the system

  • disqualifiedCompanyReason
    Type: integernullable

    Company Disqualification Reason - Reason for disqualifying the entire company

  • disqualifiedReason
    Type: integernullable

    Disqualification Reason - Why the lead was disqualified (required when status is DISQUALIFIED)

  • engagementScore
    Type: enumnullable

    Engagement Score - Measures the lead's level of interest and interaction (COLD, LUKEWARM, ON_FIRE)

    values
    123
  • inboundCampaignType
    Type: integernullable

    Inbound Campaign Type - Specific inbound marketing campaign that generated this lead

  • licenseId
    Type: stringnullable

    License ID - Specific product license being evaluated or discussed

  • name
    Type: string
    max length:  
    256

    Lead name - A descriptive name for the lead, typically including company and opportunity details

  • propertyName
    additionalPropertyType: anything

Responses

  • application/json
  • application/json
  • application/json
Request Example for patch/{entity_id}
curl 'https://crm.dreamhub.ai/api/v1/leads/{entity_id}?include_additionals=false' \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "Acme Corp - Enterprise Platform Evaluation",
  "sdrOwner": "u-abc123",
  "aeOwner": "u-xyz789",
  "companyId": "c-company123",
  "contactId": "p-contact789",
  "status": 1,
  "createdAt": "2024-01-15T10:30:00Z",
  "engagementScore": 1,
  "conversionProbability": 0.75,
  "source": 1,
  "disqualifiedReason": 1,
  "disqualifiedCompanyReason": 2,
  "closedAsQualifiedReason": 1,
  "statusNotes": "Waiting for budget approval from CFO",
  "statusChangedBy": "u-user123",
  "statusChangedAt": "2024-01-20T14:45:00Z",
  "licenseId": "l-license123",
  "productId": "prod-platform",
  "numberOfLicenses": 10,
  "salesExplorationMeetingDate": "2024-02-01T15:00:00Z",
  "inboundCampaignType": 1,
  "outboundCampaignType": 2,
  "referringCompany": "c-referrer123",
  "referringPerson": "p-referrer456",
  "otherCompanyName": "Subsidiary Corp",
  "otherPersonName": "John Smith (Decision Maker)",
  "partnerId": "ptn-partner123",
  "partnerContactId": "ptc-contact789",
  "additionalProperty": "anything"
}'

{
  "name": "Acme Corp - Enterprise Platform Evaluation",
  "sdrOwner": "u-abc123",
  "aeOwner": "u-xyz789",
  "companyId": "c-company123",
  "contactId": "p-contact789",
  "status": 1,
  "createdAt": "2026-11-12T20:58:47.594Z",
  "engagementScore": 1,
  "conversionProbability": 0.75,
  "source": 1,
  "disqualifiedReason": 1,
  "disqualifiedCompanyReason": 2,
  "closedAsQualifiedReason": 1,
  "statusNotes": "Waiting for budget approval from CFO",
  "statusChangedBy": "u-user123",
  "statusChangedAt": "2024-01-20T14:45:00Z",
  "licenseId": "l-license123",
  "productId": "prod-platform",
  "numberOfLicenses": 10,
  "salesExplorationMeetingDate": "2024-02-01T15:00:00Z",
  "inboundCampaignType": 1,
  "outboundCampaignType": 2,
  "referringCompany": "c-referrer123",
  "referringPerson": "p-referrer456",
  "otherCompanyName": "Subsidiary Corp",
  "otherPersonName": "John Smith (Decision Maker)",
  "partnerId": "ptn-partner123",
  "partnerContactId": "ptc-contact789",
  "previousStatus": 1,
  "companyUpdated": false,
  "personUpdated": false,
  "tokenHolder": "string",
  "tokenHolderNextSteps": "string",
  "closedAt": "2026-11-12T20:58:47.595Z",
  "lastModifiedBy": "string",
  "salesExplorationStatus": "not_booked",
  "id": "l-logi-f47ac10b",
  "lastActivity": "2026-11-12T20:58:47.595Z",
  "openForDays": 1,
  "salesExplorationStatusDisplay": "string",
  "contactJobTitle": "string",
  "contactEmail": "string",
  "contactFirstName": "string",
  "contactLastName": "string",
  "companyName": "string",
  "productName": "string",
  "contact": "string",
  "additionalProperty": "anything"
}

Successful Response

Previous
Update Entity
Next
Delete Entity