Delink related list records

Delete the association between module records and related list records.

Endpoints

DELETE /{module_api_name}/{record_id}/{related_list_api_name}/{related_record_id}

DELETE /{module_api_name}/{record_id}/{related_list_api_name}?ids={related_record_id1,related_record_id2,...}

Request URL

Bigin APIs are available across eight different domains, and you must choose the one relevant to your data center (DC):

To delink multiple related list records

DELETEhttps://www.zohoapis.com/bigin/v2/{module_api_name}/{record_id}/{related_list_api_name}?ids={related_record_id1,related_record_id2,...}

DELETEhttps://www.zohoapis.eu/bigin/v2/{module_api_name}/{record_id}/{related_list_api_name}?ids={related_record_id1,related_record_id2,...}

DELETEhttps://www.zohoapis.com.au/bigin/v2/{module_api_name}/{record_id}/{related_list_api_name}?ids={related_record_id1,related_record_id2,...}

DELETEhttps://www.zohoapis.in/bigin/v2/{module_api_name}/{record_id}/{related_list_api_name}?ids={related_record_id1,related_record_id2,...}

DELETEhttps://www.zohoapis.com.cn/bigin/v2/{module_api_name}/{record_id}/{related_list_api_name}?ids={related_record_id1,related_record_id2,...}

DELETEhttps://www.zohoapis.jp/bigin/v2/{module_api_name}/{record_id}/{related_list_api_name}?ids={related_record_id1,related_record_id2,...}

DELETEhttps://www.zohoapis.sa/bigin/v2/{module_api_name}/{record_id}/{related_list_api_name}?ids={related_record_id1,related_record_id2,...}

DELETEhttps://www.zohoapis.ca/bigin/v2/{module_api_name}/{record_id}/{related_list_api_name}?ids={related_record_id1,related_record_id2,...}

To delink a specific related list record

DELETEhttps://www.zohoapis.com/bigin/v2/{module_api_name}/{record_id}/{related_list_api_name}/{related_record_id}

DELETEhttps://www.zohoapis.eu/bigin/v2/{module_api_name}/{record_id}/{related_list_api_name}/{related_record_id}

DELETEhttps://www.zohoapis.com.au/bigin/v2/{module_api_name}/{record_id}/{related_list_api_name}/{related_record_id}

DELETEhttps://www.zohoapis.in/bigin/v2/{module_api_name}/{record_id}/{related_list_api_name}/{related_record_id}

DELETEhttps://www.zohoapis.com.cn/bigin/v2/{module_api_name}/{record_id}/{related_list_api_name}/{related_record_id}

DELETEhttps://www.zohoapis.jp/bigin/v2/{module_api_name}/{record_id}/{related_list_api_name}/{related_record_id}

DELETEhttps://www.zohoapis.sa/bigin/v2/{module_api_name}/{record_id}/{related_list_api_name}/{related_record_id}

DELETEhttps://www.zohoapis.ca/bigin/v2/{module_api_name}/{record_id}/{related_list_api_name}/{related_record_id}

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}.WRITE
ZohoBigin.modules.{module_name}.DELETE

In the above scope, replace {module_name} with the necessary. The possible modules include pipelines, contacts, accounts (companies in Bigin), and products.

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

record_id stringRequired

The unique identification of a record in a module. You can get the record ID from the Get records API.

related_list_api_name stringRequired

The API name of the related list. The supported related lists for the specified module can be obtained from Get related lists metadata API.

related_record_id stringRequired

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

Query parameters

ids stringRequired

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

Note: You can only delete up to 100 related records at once. So, make sure the request URL contains a maximum of 100 related record IDs.

Sample request

Curl Deluge

Copiedcurl "https://www.zohoapis.com/bigin/v2/Products/3652397000000327001/Pipelines?ids=3652397000000925128,3652397000000649013" \
-X DELETE \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf" \

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Products/3652397000000327001/Pipelines?ids=3652397000000925128,3652397000000649013"
	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": "3652397000000925128"
            },
            "message": "relation removed",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "id": "3652397000000649013"
            },
            "message": "relation removed",
            "status": "success"
        }
    ]
}