Skip to main content
POST
Create Opportunity

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

name
string
required
Minimum string length: 1
pipeline_id
string<uuid>
required
stage_id
string<uuid>
required
contact_id
string<uuid> | null
status
enum<string>
  • open - open
  • won - won
  • lost - lost
Available options:
open,
won,
lost
score
integer | null
Required range: 0 <= x <= 100
value
string<decimal> | null
Pattern: ^-?\d{0,16}(?:\.\d{0,2})?$
notes
string

Response

Opportunity created.

{key}
any