Update a opportunity record by externalId

Updates the record based on the object, externalId, and the details of the record that you want to update.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

External ID of the record. For example: 2614d72c-edfc-4dc5-b72f-45104fe5ef43.

Query Params
boolean

Set to true to get the payload in response.

Note: Default value set to false.

boolean
Body Params

Details about the record. For example: Name = "Mark", Description = "Description".
///

Note: The fields/properties should be part of the schema/metadata created for the object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.


Refer to the following table to understand the behavior when you pass ID in the payload.

         | ID in payload? | Behavior | Validation |
         |----------------|----------|------------|
         | Yes            | Update a record by `externalId`. | The record's ID must match the ID provided in the payload. If not, give an error. Do not allow the ID to be updated in any case. |
         | No             | Update a record by `externalId`. | NA |

Opportunity Request Example

string | null

Name for the record

Account
object | null

Account Id and Name associated with record

Contact
object | null

Contact Id and Name associated with record

string | null

Description for the record

string | null

Financial reporting year

string | null

Forcast category for record

string | null

Name of forcast category for record

string | null

Has opportunity lineitem

boolean

Has open activity

string | null

Lead source for record

string | null

Stage Name for record

string | null

Total opportuninty qunatity for record

Responses

400

Bad Request

403

Forbidden

404

Not Found

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json