Insert a new custom object record

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

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

Name of the custom object in which the record is to be inserted. It can only contain alphanumeric characters and underscores, and must contain "_c" in the suffix.

For example: CustomObject_c.

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 |
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
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