Skip to main content
POST
/
deals
Create deal
curl --request POST \
  --url https://app.dilli.studio/api/v1/deals \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "deal_stage_external_id": "<string>",
  "user_id": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "estimated_value": 123,
  "currency": "<string>",
  "expected_close_date": "2023-12-25",
  "stage": {
    "id": "<string>",
    "external_id": "<string>",
    "name": "<string>",
    "pipeline_id": "<string>",
    "order": 123,
    "color": "<string>",
    "probability": 123
  },
  "user": {
    "id": "<string>",
    "name": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
Use the API Playground below to send this request with your X-Api-Key. The base URL and headers are prefilled; update any path, query, or body fields and click Send.

Authorizations

X-Api-Key
string
header
required

Body

application/json
name
string
required
deal_stage_external_id
string
required

Stage external identifier (stable across edits)

user_id
string
required

Deal owner

estimated_value
number
expected_close_date
string<date> | null
contact_ids
string[]
product_ids
string[]
properties
object

Response

201 - application/json

Created

id
string

ULID

name
string
estimated_value
number<float>
currency
string
expected_close_date
string<date> | null
stage
object
user
object
created_at
string<date-time>
updated_at
string<date-time>