Update a record by externalId

put

https://rls.congacloud.com/api/data/v1/custom-objects/{objectName}/by-externalId/{externalId}

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

objectName

string

required

Name of the object. It can only contain underscores and alphanumeric characters. For example: PaymentTool, PaymentToolHistory.

externalId

string

required

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

Query Params

IncludeRecordPayloadInResponse

boolean

Set to true to get the payload in response.

Note: Default value set to false.

EnforceOptimisticLocking

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 |

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

Bad Request

403

Forbidden

404

Not Found

200OK

500Internal Server Error