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

Query Parameters

  • Whether to include additional fields from the additional fields tab.

Body·

required
application/json
  • Integer numbers.

  • Integer numbers.

  • Integer numbers.

  • Integer numbers.

Responses

  • application/json
  • application/json
  • application/json
Request Example for patch/thresholds/{entity_id}
curl 'https://crm.dreamhub.ai/api/v1/settings/thresholds/{entity_id}?include_additionals=false' \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "id": "",
  "low": 1,
  "medium": 1,
  "high": 1,
  "max": 1,
  "additionalProperty": "anything"
}'
{
  "id": "thr-f47ac10b",
  "low": 1,
  "medium": 1,
  "high": 1,
  "max": 1,
  "createdAt": "2026-11-12T20:58:57.930Z",
  "additionalProperty": "anything"
}