Update opportunity state

PUT

/api/nova/opportunities/{opportunityId}/status

Moves an opportunity to a different state, for example open, won or lost. The request body requires statusId referencing an opportunity state from the account's master data, and accepts an optional reasonId and comments recorded with the change. Returns 400 when statusId is missing and 404 when either the opportunity or the state cannot be found. On success the opportunity id is returned. 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

{

  

"comments": "string",

  

"reasonId": "string",

  

"statusId": "string"

}

Responses

OK

Content-Type

application/json

{

  

"data": "string",

  

"error": "string",

  

"message": "string",

  

"requestId": "string",

  

"success": true

}

PUT

/api/nova/opportunities/{opportunityId}/status

Playground

Authorization

privateApiKey

Variables

Key

Value

opportunityId*

apiKey*

Body

Samples