Skip to content
Vibase Vibase Docs

Create a deal

POST
/api/v1/deals

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
name
required
string
>= 1 characters <= 200 characters
amount_minor

Optional, in the currency’s minor units (cents; for JPY the unit). Needs a currency.

integer | null
<= 9007199254740991
currency

Optional ISO 4217 code such as USD; stored upper case.

string | null
/^[A-Za-z]{3}$/
expected_close_date

Optional calendar date, YYYY-MM-DD.

string | null format: date
owner_id
string | null format: uuid
stage_id
required
string format: uuid

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Success

object
id
required
string format: uuid
organization_id
required
string format: uuid
name
required
string
pipeline_id
required
string format: uuid
stage_id
required
string format: uuid
status

The kind of the deal’s stage: open, won or lost. Derived, read-only.

string
Allowed values: open won lost
amount_minor
required
integer | null
currency
required
string | null
expected_close_date
required
string | null
owner_id
required
string | null format: uuid
closed_at
required
string | null
created_by
required
string format: uuid
created_at
required
string
updated_at
required
string