Skip to main content
POST
Create an opportunity

Authorizations

Authorization
string
header
required

API key from Developer dashboard (Bearer token).

Body

application/json
name
string
required

Opportunity / deal name.

contact_email
string<email>
company
string
value
number

Monetary value.

pipeline_id
integer
stage
string

Stage key within the pipeline.

status
enum<string>
default:open
Available options:
open,
won,
lost,
abandoned
assigned_user_id
integer
next_action_date
string<date>
notes
string

Response

Opportunity created

success
enum<boolean>
Available options:
true
data
object
meta
object