v1

latestOpenAPI 3.1.02026-08-069158174.8 KB

CRM Service Calls

Patch Opportunity

Update an existing opportunity/deal by ID.

Send only the fields you want to change. Returns 400 if no fields are provided.

Path Parameters:

opportunity_id: The opportunity's CRM record ID.

Request Body (OpportunityUpdateRequest): Fields: name, stage, value_of_sale, probability_pcnt, expected_close_date, marketing_source, business_need_description, product_dict_list. All optional — only included fields are updated.

Response: The updated deal object.

patch/crm/opportunities/{opportunity_id}

Path parameters

opportunity_idstring required

Request body

namestring nullable

Opportunity name

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