Deals

Create a new deal

Creates a new deal in your CRM pipeline.

post/deals

Request

Base URL: https://api.heffl.com/api/v2
URL: https://api.heffl.com/api/v2/deals
Auth: API key in header x-api-key

Request body

titlestring required

Deal title

pipelineIdstring required

Pipeline public ID

stageIdstring required

Pipeline stage public ID

clientIdstring required

Client public ID (required)

leadIdstring

Lead public ID

sourceIdstring

Deal source public ID

pricenumber

Deal value/price

expectedCloseDatestring date-time

Expected close date

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

Deal priority

Response

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.