Opportunity
Create opportunity
Call Outcome
Company Category
Contract Type
Custom Field
Industry
Lead Source
Loss Reason
Market Sector
Opportunity
Opp Stage
Task List
Webhook Message
Opportunity
Create opportunity
POST
/
api
/
2023-01
/
opportunities
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Authorization
string
*
Authorization
Required
string
object
opportunity
object
opportunity
object
name
string
name
string
Add Example Value
company_id
string
*
company_id
Required
string
Company ID to be associated with this opportunity
Add Example Value
probability
number
probability
number
Add Example Value
opp_stage_id
string
opp_stage_id
string
Opp Stage ID to be associated with this opportunity
Add Example Value
close_type
enum<string>
close_type
enum<string>
Close type of the opportunity
Add Example Value
award_date
string
award_date
string
Add Example Value
bid_due_date
string
bid_due_date
string
Add Example Value
start_date
string
start_date
string
Add Example Value
end_date
string
end_date
string
Add Example Value
description
string
description
string
Add Example Value
square_feet
integer
square_feet
integer
Add Example Value
units
integer
units
integer
Add Example Value
address
object
address
object
street_address
string
*
street_address
Required
string
Add Example Value
street_address2
string
*
street_address2
Required
string
Add Example Value
city
string
*
city
Required
string
Add Example Value
state
string
state
string
Add Example Value
zip
string
*
zip
Required
string
Add Example Value
country
enum<string>
*
country
Required
enum<string>
Add Example Value
assigned_to_id
string
assigned_to_id
string
User ID to be associated with this opportunity
Add Example Value
contact_id
string
contact_id
string
Contact ID to be associated with this opportunity
Add Example Value
contract_type_id
string
contract_type_id
string
Contract Type ID to be associated with this opportunity
Add Example Value
lead_source_id
string
lead_source_id
string
Lead Source ID to be associated with this opportunity
Add Example Value
loss_reason_id
string
loss_reason_id
string
Loss Reason ID to be associated with this opportunity
Add Example Value
market_sector_id
string
market_sector_id
string
Market Sector ID to be associated with this opportunity
Add Example Value
Headers
Authorization
string
requiredBody
application/json
opportunity
object
Response
201 - application/json
opportunity
object
required