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

    Account Executive owner ID

  • annualContractValue
    Type: numbernullable

    Annual contract value

  • annualContractValueLocal
    Type: numbernullable

    Annual contract value in local currency

  • arr
    Type: numbernullable

    Annual Recurring Revenue

  • arrLocal
    Type: numbernullable

    Annual Recurring Revenue in local currency

  • automaticallyAddedPartnerContacts
    Type: array of stringnullable

    Partner contacts automatically added to this contract

  • automaticallyAddedPeople
    Type: array of stringnullable

    People automatically added to this contract

  • carr
    Type: numbernullable

    Committed Annual Recurring Revenue

  • carrLocal
    Type: numbernullable

    Committed Annual Recurring Revenue in local currency

  • cmrr
    Type: numbernullable

    Committed Monthly Recurring Revenue

  • cmrrLocal
    Type: numbernullable

    Committed Monthly Recurring Revenue in local currency

  • companyId
    Type: string
    max length:  
    50    nullable

    Identifier of the associated company

  • propertyName
    additionalPropertyType: anything

Responses

  • application/json
  • application/json
  • application/json
Request Example for patch/{entity_id}
curl 'https://crm.dreamhub.ai/api/v1/contracts/{entity_id}?include_additionals=false' \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "",
  "dealId": "",
  "companyId": "",
  "productId": "",
  "status": 1,
  "arr": 1,
  "arrLocal": 1,
  "mrr": 1,
  "mrrLocal": 1,
  "currency": "",
  "revenueItems": [
    ""
  ],
  "annualContractValue": 1,
  "annualContractValueLocal": 1,
  "totalContractValue": 1,
  "totalContractValueLocal": 1,
  "startDate": "2026-11-12T20:58:39.627Z",
  "endDate": "2026-11-12T20:58:39.627Z",
  "duration": 1,
  "renewalType": 1,
  "nextRenewal": "2026-11-12T20:58:39.627Z",
  "nextOptOut": "2026-11-12T20:58:39.627Z",
  "signedOn": "2026-11-12T20:58:39.627Z",
  "csmOwner": "",
  "aeOwner": "",
  "carr": 1,
  "carrLocal": 1,
  "cmrr": 1,
  "cmrrLocal": 1,
  "financialOverride": true,
  "financialNote": "",
  "currentFxRate": 1,
  "csmRenewalConfidenceLevel": 1,
  "isDetachedFromDeal": true,
  "manuallyAddedPeople": [
    ""
  ],
  "automaticallyAddedPeople": [
    ""
  ],
  "partnerId": "",
  "manuallyAddedPartnerContacts": [
    ""
  ],
  "automaticallyAddedPartnerContacts": [
    ""
  ],
  "onboardingStartDate": "2026-11-12T20:58:39.628Z",
  "onboardingCompletedAt": "2026-11-12T20:58:39.628Z",
  "uploadFiles": {
    "additionalProperty": null
  },
  "additionalProperty": "anything"
}'

{
  "name": "string",
  "dealId": "string",
  "companyId": "string",
  "productId": "string",
  "status": 1,
  "arr": 1,
  "arrLocal": 1,
  "mrr": 1,
  "mrrLocal": 1,
  "currency": "string",
  "revenueItems": [],
  "annualContractValue": 1,
  "annualContractValueLocal": 1,
  "totalContractValue": 1,
  "totalContractValueLocal": 1,
  "startDate": "2026-11-12T20:58:39.635Z",
  "endDate": "2026-11-12T20:58:39.635Z",
  "duration": 1,
  "renewalType": 1,
  "nextRenewal": "2026-11-12T20:58:39.635Z",
  "nextOptOut": "2026-11-12T20:58:39.635Z",
  "signedOn": "2026-11-12T20:58:39.635Z",
  "csmOwner": "string",
  "aeOwner": "string",
  "carr": 1,
  "carrLocal": 1,
  "cmrr": 1,
  "cmrrLocal": 1,
  "financialOverride": true,
  "financialNote": "string",
  "currentFxRate": 1,
  "csmRenewalConfidenceLevel": 1,
  "isDetachedFromDeal": true,
  "manuallyAddedPeople": [
    "string"
  ],
  "automaticallyAddedPeople": [
    "string"
  ],
  "partnerId": "string",
  "manuallyAddedPartnerContacts": [
    "string"
  ],
  "automaticallyAddedPartnerContacts": [
    "string"
  ],
  "onboardingStartDate": "2026-11-12T20:58:39.635Z",
  "onboardingCompletedAt": "2026-11-12T20:58:39.635Z",
  "uploadFiles": {
    "additionalProperty": null
  },
  "id": "con-f47ac10b",
  "calculatedCarr": 1,
  "calculatedCarrLocal": 1,
  "calculatedCmrr": 1,
  "calculatedCmrrLocal": 1,
  "calculatedAnnualContractValue": 1,
  "calculatedAnnualContractValueLocal": 1,
  "calculatedTotalContractValue": 1,
  "calculatedTotalContractValueLocal": 1,
  "calculatedArr": 1,
  "calculatedArrLocal": 1,
  "calculatedMrr": 1,
  "calculatedMrrLocal": 1,
  "closeFxRate": 1,
  "currentFxRateRefreshedAt": "2026-11-12T20:58:39.636Z",
  "currentFxRateModifiedBy": "string",
  "onboardingStageId": "string",
  "duplicatedFromContractId": "string",
  "snapshotOfDealId": "string",
  "createdAt": "2026-11-12T20:58:39.636Z",
  "terminationNotice": {
    "id": "string",
    "contractId": "string",
    "scope": "ENTIRE_CONTRACT",
    "state": "SCHEDULED",
    "noticeDate": "2026-11-12T20:58:39.636Z",
    "effectiveEndDate": "2026-11-12T20:58:39.636Z",
    "reasonId": 1,
    "notes": "string",
    "createdBy": "string",
    "createdAt": "2026-11-12T20:58:39.636Z",
    "items": [
      {
        "revenueItemId": "string",
        "action": "END",
        "newServiceEndDate": "2026-11-12T20:58:39.636Z",
        "newTotalLocal": 1,
        "originalServiceEndDate": "2026-11-12T20:58:39.636Z",
        "originalTotalLocal": 1,
        "originalAutoRenewal": true
      }
    ]
  },
  "serviceCount": 1,
  "period": "string",
  "csmRenewalConfidenceLevelLabel": "string",
  "onboardingStageName": "string",
  "onboardingStatus": "string",
  "percentageFromCsmRenewalBook": 1,
  "durationDisplay": "string",
  "additionalProperty": "anything"
}

Successful Response

Previous
Update Entity
Next
Delete Entity