Update Deals Commercial

​

Path Parameters

  • deal_id
    Type: string
    required

Body·

required
application/json
  • amountBreakdownByPeriod
    nullable

    Amount breakdown by period

    Amount breakdown by period

    • propertyName
      additionalPropertyType: anything
  • annualContractValue
    Type: numbernullable

    Annual contract value

  • arr
    Type: numbernullable

    Deal ARR

  • arrLocal
    Type: numbernullable

    Deal ARR in account's system currency

  • autoRenewal
    Type: booleannullable

    Auto renewal flag

  • contractEndDate
    Type: stringFormat: date-timenullable

    Contract end date

  • contractId
    Type: stringnullable

    Contract ID

  • contractStartDate
    Type: stringFormat: date-timenullable

    Contract start date

  • contractTotalAmount
    Type: numbernullable

    Contract total amount

  • currency
    Type: stringnullable

    Currency code (e.g. USD, EUR)

  • implementationCost
    Type: numbernullable

    Implementation cost

  • licenseId
    Type: stringnullable

    License ID

  • propertyName
    additionalPropertyType: anything

Responses

  • application/json
  • application/json
Request Example for post/{deal_id}/commercials
curl 'https://crm.dreamhub.ai/api/v1/deals/{deal_id}/commercials' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "contractStartDate": "",
  "contractEndDate": "",
  "optOutDate": "",
  "contractTotalAmount": 1,
  "amountBreakdownByPeriod": {
    "additionalProperty": "anything"
  },
  "autoRenewal": true,
  "licenseId": "",
  "productId": "",
  "licensesInDeal": 1,
  "potentialLicensesInCompany": 1,
  "implementationCost": 1,
  "trainingCost": 1,
  "uploadContracts": {
    "additionalProperty": "anything"
  },
  "annualContractValue": 1,
  "totalContractValue": 1,
  "currency": "",
  "arr": 1,
  "mrr": 1,
  "arrLocal": 1,
  "mrrLocal": 1,
  "contractId": "",
  "additionalProperty": "anything"
}'

{
  "contractStartDate": "2026-09-29T00:01:38.072Z",
  "contractEndDate": "2026-09-29T00:01:38.072Z",
  "optOutDate": "2026-09-29T00:01:38.072Z",
  "contractTotalAmount": 1,
  "amountBreakdownByPeriod": {
    "additionalProperty": "anything"
  },
  "autoRenewal": true,
  "licenseId": "string",
  "productId": "string",
  "licensesInDeal": 1,
  "potentialLicensesInCompany": 1,
  "implementationCost": 1,
  "trainingCost": 1,
  "uploadContracts": {
    "additionalProperty": "anything"
  },
  "annualContractValue": 1,
  "totalContractValue": 1,
  "currency": "string",
  "arr": 1,
  "mrr": 1,
  "arrLocal": 1,
  "mrrLocal": 1,
  "contractId": "string",
  "additionalProperty": "anything"
}

Successful Response