Update Entity

​

Update an existing entity with new data.

This endpoint supports both full and partial updates:

  • Partial Update: Provide only the fields you want to change. All other fields remain unchanged.
  • Full Update: Provide all fields to completely replace the entity data.

Args: entity_id: Unique identifier of the entity to update entity_info: Updated entity data including: - Fields to modify (partial update supported - only changed fields required) - All unchanged fields will 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 - 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
Request Example for put/thresholds/{entity_id}
curl 'https://crm.dreamhub.ai/api/v1/settings/thresholds/{entity_id}?include_additionals=false' \
  --request PUT \
  --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-09-29T00:01:58.887Z",
  "additionalProperty": "anything"
}