Update an opportunity

put

https://api.costructor.co/external/v1/opportunities/{id}

Updates an opportunity. Send only the fields to change. Changing stage moves the opportunity in the pipeline and records it in its history.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The opportunity ID (opp_...)

Body Params

name

string

Opportunity name (e.g. "Bathroom renovation")

contact

string

Contact ID (cnt_...) of the customer or lead

stage

string

Pipeline stage ID (ops_...), see List all opportunity stages. On creation, defaults to the first open stage of the pipeline. Moving to a stage whose outcome is won or lost sets the status accordingly.

amount

integer

Estimated amount excl. VAT, in cents

source

string

Where the opportunity comes from (free text, e.g. website, referral, phone)

notes

string

Internal notes

address

object

Job site address

score

integer

0 to 100

Defaults to 50

Likelihood of winning, from 0 to 100

expectedCloseAt

date-time

Expected closing date

lostReason

string

Reason the opportunity was lost

lostReasonCustom

string

Free-text details on the lost reason

status

string

enum

Opportunity status. Usually derived from the stage.

Allowed:

Response

200