Update an opportunity

PUT

/api/nova/opportunities/{opportunityId}

Updates an existing opportunity identified by the path id. Fields supplied in the request body overwrite the existing values and omitted fields are left unchanged; stateId is resolved against the account's opportunity states and custom UDF fields replace the stored custom field values when provided. Returns 404 when the opportunity is not found and the opportunity id on success. Responds with 401 for an invalid API key and 429 when API usage limits are exceeded.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Path Parameters

opportunityId*

opportunityId

Type

string

Required

Query Parameters

apiKey*

apiKey

Type

string

Required

Request Body

application/json

{

  

"actualClosingDate": "string",

  

"bidCurrency": "string",

  

"bidValue": 0,

  

"companyId": "string",

  

"contactId": "string",

  

"customFields": [

  

  

{

  

  

  

"boolValue": "string",

  

  

  

"dateValue": "string",

  

  

  

"fieldId": "string",

  

  

  

"fieldLabel": "string",

  

  

  

"listValue": [

  

  

  

  

"string"

  

  

  

],

  

  

  

"value": "string"

  

  

}

  

],

  

"description": "string",

  

"estimatedDurationMonths": 0,

  

"forecastedClosingDate": "string",

  

"id": "string",

  

"name": "string",

  

"ownerId": "string",

  

"probability": 0,

  

"startDate": "string",

  

"stateId": "string",

  

"tags": [

  

  

{

  

  

  

"group": "string",

  

  

  

"value": "string"

  

  

}

  

]

}

Responses

OK

Content-Type

application/json

{

  

"data": "string",

  

"error": "string",

  

"message": "string",

  

"requestId": "string",

  

"success": true

}

PUT

/api/nova/opportunities/{opportunityId}

Playground

Authorization

privateApiKey

Variables

Key

Value

opportunityId*

apiKey*

Body

Samples