Update multiple opportunity records

Validates the object record details and updates multiple records in the given object.

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

The field to use for updating the record.

Note: Default value set to ID.

Allowed:
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", ID = "263rd72c-edfc-4dc5-b72f-45104fe5ef43", externalId = "4614d72c-edfd-4dc5-b72f-45104fe5ef43".

Note: The fields/properties must be part of the schema/metadata created for the custom object (in this case, Name, Description, ID. and externalId must be fields in the schema). The schema and metadata can be generated using the Schema Manager API.

Refer to the following table to understand the behavior when you want to update records by ID field.

ID in payload?ExternalId in payload?BehaviorValidation
YesYesUpdate the record using the ID if it exists, and ensure the externalId is unique.ExternalId unique validation
YesNoUpdate the record using the ID if it exists, and ensure the externalId is unique.NA
NoYesInvalid scenario. Throw a validation error.Throw a validation error if the ID is not found, indicating that the ID must exist.
NoNoInvalid scenario. Throw a validation error.NA
Refer to the following table to understand the behavior when you want to update records by externalId field.
ID in payload?ExternalId in payload?BehaviorValidation
YesYesUpdate the record using the externalId if it exists.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.
YesNoInvalid scenario. Throw a validation error.Throw a validation error indicating that the externalId must exist.
NoYesUpdate the record using the externalId if it exists.NA
NoNoInvalid scenario. Throw a validation error.Throw a validation error indicating that the externalId must exist.

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
200

OK

400

Bad Request

403

Forbidden

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