Delete custom object records as per the criteria

Removes multiple records that satisfy the criteria in the 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. It can only contain alphanumeric characters and underscores, and must have "_c" in the suffix.

For example: CustomObject_c.

Query Params
boolean

Set to true to get the delete status in response.

Note: Default value set to false.

string
enum
Allowed:
Body Params

Criteria based request for delete.

string | null

Object from which the records need to be deleted.

string | null

Delete criteria for the Records. For example: IsActive = 'true'.

Note: The criteria field (in this case, IsActive) should be indexed.

int32 | null
deprecated

The number of records to display on each page.

int32 | null
deprecated

The page number of the result set to view.

int32 | null

Number of records to delete.
If NumberOfRecordsToDelete is provided PageNumber and PageSize will be ignored.

Headers
string
enum
Defaults to application/json

Generated from available request content types

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