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

    Street address

  • areaOfResponsibility
    Type: string
    max length:  
    256    nullable

    Partner area of responsibility

  • city
    Type: string
    max length:  
    256    nullable

    City

  • country
    Type: string
    max length:  
    256    nullable

    Country

  • name
    Type: string
    max length:  
    256    nullable

    Partner company name

  • parentPartner
    Type: string
    max length:  
    50    nullable

    Identifier of the parent partner company

  • partnerContacts
    Type: array of string

    Identifiers of the partner's contacts (partners_contacts IDs)

  • phoneNumber
    Type: string
    max length:  
    50    nullable

    Partner phone number

  • postalCode
    Type: string
    max length:  
    100    nullable

    Postal code

  • stateRegion
    Type: string
    max length:  
    256    nullable

    State or region

  • status
    Type: integernullable

    Partner status ID (1=Onboarding, 2=Active, 3=Inactive)

  • type
    Type: array of integer

    Partner type IDs (1=Reseller, 2=Referral, 3=System Integrator, 4=Technology Partner); a partner may have more than one

  • propertyName
    additionalPropertyType: anything

Responses

  • application/json
  • application/json
  • application/json
Request Example for patch/{entity_id}
curl 'https://crm.dreamhub.ai/api/v1/partners/{entity_id}?include_additionals=false' \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "",
  "type": [
    1
  ],
  "status": 1,
  "parentPartner": "",
  "website": "",
  "phoneNumber": "",
  "areaOfResponsibility": "",
  "partnerContacts": [
    ""
  ],
  "address": "",
  "city": "",
  "stateRegion": "",
  "postalCode": "",
  "country": "",
  "additionalProperty": "anything"
}'

{
  "name": "string",
  "type": [
    1
  ],
  "status": 1,
  "parentPartner": "string",
  "website": "string",
  "phoneNumber": "string",
  "areaOfResponsibility": "string",
  "partnerContacts": [
    "string"
  ],
  "address": "string",
  "city": "string",
  "stateRegion": "string",
  "postalCode": "string",
  "country": "string",
  "id": "par-f47ac10b",
  "createdAt": "2026-11-12T20:58:49.956Z",
  "additionalProperty": "anything"
}

Successful Response

Previous
Update Entity
Next
Delete Entity