Skip to main content
POST
Create an opportunity

Authorizations

Authorization
string
header
required

Workspace API key sent as a bearer token: Authorization: Bearer failfast_.... Create keys in Settings -> Workspace -> API Keys.

Body

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

lead
string<uuid>
required
custom_fields
unknown
status
string
Maximum string length: 50
stage
string
Maximum string length: 50
expected_value
string<decimal> | null
Pattern: ^-?\d{0,14}(?:\.\d{0,6})?$
probability
integer
Required range: -2147483648 <= x <= 2147483647
last_activity_at
string<date-time> | null
last_activity_type
string | null
Maximum string length: 50
close_date
string<date> | null
sales_quote
string<uuid> | null

Response

201 - application/json
message
string
required

Human-readable outcome of the request.

error
boolean
required

true when the request failed.

Example:

false

data
object
required

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.