Delete custom object records

delete

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

Removes multiple records from the given custom object.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

objectName

string

required

Name of the custom object. It can only contain alphanumeric characters and underscores, and must have "_c" in the suffix.

For example: CustomObject_c.

Query Params

DeleteByField

string

enum

The field to use for deleting the record.

Note: Default value set to Id.

Allowed:

DeleteBehaviour

string

enum

whether to do a soft/hard delete record or not

Allowed:

IncludeDeleteResultStatus

boolean

Set to true to get the delete status in response.

Note: Default value set to false.

Body Params

Multiple record IDs to be deleted. For example: 2614d72c-edfc-4dc5-b72f-45104fe5ef43.

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

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

500Internal Server Error