Insert a new opportunity record

Validates the record details and inserts if it does not exist in the given object.

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

Set to true to get the payload in response.

Note: Default value set to false.

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 schema fields). The schema and metadata can be generated using the Schema Manager APIs.


Refer to the following table to understand the behavior when you pass ID and/or External ID.

         | ID in payload? | ExternalId in payload? | Behavior | Validation |
         |----------------|------------------------|----------|------------|
         | Yes            | Yes                    | Create a record using the ID field value as provided in the payload. | ExternalId unique validation |
         | Yes            | No                     | Create a record using the ID field value as provided in the payload and set the ExternalId to null. | NA |
         | No             | Yes                    | Generate a new GUID and create a record using the ID field value with the new GUID value. | ExternalId unique validation |
         | No             | No                     | Generate a new GUID and create a record using the ID field value with the new GUID value and set the ExternalId to null. | 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

Found unknown field(s)

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