Deals

Update a deal

Updates an existing deal. Only provided fields will be updated.

patch/deals/{id}

Request

  • Base URL: https://api.heffl.com/api/v1
  • URL: https://api.heffl.com/api/v1/deals/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Deal public ID

Request body

titlestring

Deal title

pricenumber

Deal value/price

stageIdstring

Pipeline stage public ID

status'ACTIVE' | 'WON' | 'LOST'

Deal status (ACTIVE, WON, LOST)

priority'LOW' | 'MEDIUM' | 'HIGH'

Deal priority

sourceIdstring

Deal source public ID

expectedCloseDatestring date-time

Expected close date

Response

OK

idstring required

Deal public ID

numberstring nullable

Auto-generated deal number

titlestring required

Deal title

pricenumber nullable

Deal price/value

statusstring nullable

Deal status

prioritystring nullable

Deal priority

expectedCloseDatestring date-time nullable

Expected close date

clientIdstring nullable

Client public ID

pipelineIdstring nullable

Pipeline public ID

stageIdstring nullable

Pipeline stage public ID

sourceIdstring nullable

Deal source public ID

leadIdstring nullable

Lead public ID

createdAtstring date-time required

When the deal was created

customFieldsobject nullable

Custom field values

Changes

No recorded changes to this operation across all 1 revision of this API.