v1

latestOpenAPI 3.1.02026-08-069158174.8 KB
CRM Service Calls

Post Opportunity

Create a new opportunity/deal.

At least one of account_id or contact_id is required to link the deal to an existing account or contact.

Request Body (OpportunityRequest):

  • name (required): Opportunity name.
  • account_id (optional): FK to an account (company).
  • contact_id (optional): FK to a contact (decision maker).
  • stage (default: "discovery"): Pipeline stage. Values: draft, prospecting, discovery, developing, negotiation_review, contract_pending, closed_won, closed_lost.
  • value_of_sale (optional): Deal amount (float).
  • probability_pcnt (optional): Win probability 0–1 (e.g., 0.75 = 75%).
  • expected_close_date (optional): Epoch timestamp (seconds).
  • marketing_source (optional): Marketing source name.
  • business_need_description (optional): Pain points / business need.
  • product_dict_list (optional): Array of products, e.g. [{"product_id":"...","unit_amount":50000,"unit_count":1}].

Response: The created deal object.

post/crm/opportunities

Request body

namestring required

Opportunity name

account_idstring nullable

FK to Accounts (company). At least one of account_id or contact_id is required.

contact_idstring nullable

FK to AccountContacts (decision maker). At least one of account_id or contact_id is required.

stagestring nullable

Possible values: draft, prospecting, discovery, developing, negotiation_review, contract_pending, closed_won, closed_lost

value_of_salenumber nullable

Deal amount

probability_pcntnumber nullable

Win probability 0-1 (e.g. 0.75 = 75%)

expected_close_dateinteger nullable

Expected close date (epoch timestamp)

marketing_sourcestring nullable

Marketing source name

business_need_descriptionstring nullable

Business need / pain points

Response

Successful Response

idstring required
namestring required
stagestring required
marketing_sourcestring nullable
agent_namestring nullable
agent_emailstring nullable
agent_phonestring nullable
contact_namestring nullable
contact_emailstring nullable
contact_phonestring nullable
account_namestring nullable
account_emailstring nullable
value_of_salestring nullable
estimated_value_of_salestring nullable
created_datestring nullable
updated_datestring nullable
expected_close_datestring nullable
close_datestring nullable
renewal_datestring nullable