Delete records

Delete multiple records or a specific record from a module.

Endpoints

DELETE /{module_api_name}?ids={record_id1,record_id2,..}

DELETE /{module_api_name}/{record_id}

Request URL

For multiple records, use

{api-domain}/bigin/v2/{module_api_name}?ids={record_id1,record_id2,..}

For a specific record, use

{api-domain}/bigin/v2/{module_api_name}/{record_id}

Choose domain-specific URL to replace {api-domain}

You can use the domain-specific URL to access Bigin resources. Based on the data center in which the Bigin account's resources are available, replace {api-domain} in the preceding request with one of the following API domain URLs:

For US, https://www.zohoapis.com
For EU, https://www.zohoapis.eu
For AU, https://www.zohoapis.com.au
For IN, https://www.zohoapis.in
For CN, https://www.zohoapis.com.cn
For JP, https://www.zohoapis.jp

For more information, see Multi DC Support.

Authorization

For this endpoint, pass the access token as an authorization header. See OAuth Authentication for more information about access tokens.

Authorization: Zoho-oauthtoken <ACCESS_TOKEN>

You must authenticate using an access token that is associated with one of the following scopes:

ZohoBigin.modules.ALL
ZohoBigin.modules.{module_name}.ALL
ZohoBigin.modules.{module_name}.DELETE

In the above scope, replace {module_name} with the module for which you want to retrieve the records. The possible modules include contacts, accounts (companies in Bigin), products, calls, events, and tasks.

Notes:

A maximum of 100 records can be deleted per API call.
By default, all the workflows related to this API will get executed.

Request parameters

The available request parameters are given below:

Path parameters

module_api_name stringRequired

The API name of the module. The possible modules for this endpoint and their API name are given below:

Module	API Name
Contacts	Contacts
Pipelines	Pipelines
Companies	Accounts
Products	Products
Tasks	Tasks
Events	Events
Calls	Calls

record_id stringOptional

The unique identification of a record in a module. Use this when you want to delete a specific record in a module. You can get the record ID from the Get records API.

Query parameters

ids stringRequired

Specify the unique identification (record ID) of records you want to delete from a module. It accepts multiple record IDs separated by commas. You can get the record ID from the Get records API. For example, if you want to delete multiple records from a module, you can pass them as ids=410405000002264040,410405000002264025.

wf_trigger booleanOptional

Controls the triggering of workflow rules when a record is deleted. The default value is true.

Possible values:true (activates associated workflows), false (deactivates associated workflows).

Sample request

Curl Deluge

Copiedcurl "https://www.zohoapis.com/bigin/v2/Pipelines?ids=2034020000000459524,2034020000000478069&wf_trigger=false" \
-X DELETE \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v2/Pipelines?ids=2034020000000459524,2034020000000478069&wf_trigger=false"
	type: DELETE
	connection:"connection_link_name"
];
info response;

Response object

The response object provides information regarding the success message or status.

Possible error codes

The response of this resource includes HTTP status and error codes.

Sample response

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "2034020000000459524"
            },
            "message": "record deleted",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "id": "2034020000000478069"
            },
            "message": "record deleted",
            "status": "success"
        }
    ]
}