Delete Record by ID - v2.1

Updates in V2.1

1. New parameters have been added:

In V2.1, by default, all associated workflows will get triggered. skip_workflow parameter key allows the restriction of schedules and form workflows. In API V2, this provision of skipping certain workflows is not possible.

Overview
Request Details
Body
Understanding the Response
Possible Errors

Overview

This API deletes a specific record, identified by its ID value, which is displayed in a report of your Zoho Creator application. The delete request is subject to custom validations configured for the target form.

Request Details

Request URL

https://<base_url>/creator/v2.1/data/<account_owner_name>/<app_link_name>/report/<report_link_name>/<record_ID>

Request method

DELETE

Header

Key	Value	Description
Authorization	Zoho-oauthtoken 1000.8cb99dxxxx xxxxxxxxx9be93.9 b8xxxxxxxxxxxxxxxf	An authentication token (authtoken) allows users to access apps and APIs without having to enter their login credentials each time.
environment	development/stage	Refers to the environment stage.
demo_user_name	demouser_1, demouser_2, demouser_3..	Demo users in your Creator app can be appended along with the environment.

Note: By default, production value will be considered for the environment header.

OAuth scope

scope=ZohoCreator.report.DELETE

where,

base_url	the base URL of your ZohoCreator account For example, it's www.zohoapis.com if your account belongs to Zoho's US DC, and is www.zohoapis.eu if it belongs to Zoho's EU DC.
account_owner_name	the username of the Creator account's owner
app_link_name	the link name of the target application
report_link_name	the link name of the target report
record_ID	the ID of the record that you want to delete

Body

skip_workflowlist
(Optional) Prevents the associated form workflows from being executed on the deletion of a record.
Possible values: form_workflow
Note: By default:
- If this parameter is not supplied, all associated workflows will be triggered.
- Blueprints and approvals will be triggered on deletion of a record, and cannot be skipped.
Sample value for the parameter "skip_workflow" Description
"skip_workflow" : ["form_workflow"] Prevents the associated form workflows from being triggered when the record is deleted using API
Understanding the Response
The success or failure of the API will be conveyed in its response. The response of the Delete Record by ID API includes the following keys:
code
This key denotes the success or failure of the delete operation. Refer to this page for the complete list of codes and messages.
message
- When the API request includes "message": true, the response will contain "message":"Data Deleted Successfully" or the message that's configured as part of a show message workflow action
- When the API request includes "message": false or does not include this the message key, the response will contain "message":"Data Deleted Successfully"
data
This key will contain the ID of the deleted record.
tasks
When the API request includes this key with value true, the response will return the details of the form, report, page, or URL to which the target form is configured to redirect to upon successful deletion record deletion. Redirection can be set up using a redirection workflow action. The "type" key will contain the type of window in which the target URL is to open (same window, new window, or parent window). The "url" key will contain one of the following, for example:
- #Form:<form_link_name>
- #Report:<report_link_name>
- #Page:<page_link_name>
- https://www.zylker.com
Possible Errors
Refer to this page for the list of error codes and messages.

Sample Request for Production environment (for C6 users)

Curl Java JavaScript Python

Copiedcurl "https://www.zohoapis.com/creator/v2.1/data/jason18/zylker-store/report/All_Orders/3888833000000114027"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Copiedpackage org.example;

import okhttp3.HttpUrl;
import okhttp3.MediaType;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import org.json.JSONArray;
import org.json.JSONObject;

public class DeleteRecordById
{
    public static void main(String[] args)
    {
        JSONObject payload = new JSONObject();

        JSONArray skipWorkflowArr = new JSONArray();
        skipWorkflowArr.put("form_workflow");

        payload.put("skip_workflow",skipWorkflowArr);

        JSONObject resultObj = new JSONObject();
        resultObj.put("message",true);
        resultObj.put("tasks",true);

        payload.put("result",resultObj);

        OkHttpClient client = new OkHttpClient();
        MediaType mediaType = MediaType.parse("application/json");
        RequestBody body = RequestBody.create(mediaType, payload.toString());

        HttpUrl.Builder urlBuilder = HttpUrl.parse("https://www.zohoapis.com/creator/v2.1/data/jason18/zylker-store/report/All_Orders/4445260000003625063").newBuilder();
        Request request = new Request.Builder()
                .url(urlBuilder.toString())
                .method("DELETE", body)
                .addHeader("Authorization", "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf")
                .build();
        try
        {
            JSONObject response = new JSONObject(client.newCall(request).execute().body().string());
        }
        catch (Exception e)
        {
            System.out.println("Exception while making the API request.");
        }
    }
}

Copiedlet payload = {
    "skip_workflow": [
        "form_workflow"
    ],
    "result": {
        "message": true,
        "tasks": true
    }
}

let api_headers = {
    "Authorization": "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}

try {
    let response = fetch("https://www.zohoapis.com/creator/v2.1/data/jason18/zylker-store/report/All_Orders/4445260000003625059", {
        method: "DELETE",
        headers: api_headers,
        body: JSON.stringify(payload)
    })
}
catch (exception) {
    console.error(exception)
}

Copiedimport requests

payload = {
    "skip_workflow": [
        "form_workflow"
    ],
    "result": {
        "message": True,
        "tasks": True
    }
}

api_headers = {
    "Authorization": "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}

try:
    response = requests.delete("https://www.zohoapis.com/creator/v2.1/data/jason18/zylker-store/report/All_Orders/4445260000003625059", headers=api_headers, data=str(payload))
except:
    print("Exception while making the API request.")

This sample request will delete the record with ID 3888833000000114027, which is displayed in the All Orders report of the Zylker Store application.

Sample Request for Development/ Stage environments (for C6 users)

Copiedcurl "https://www.zohoapis.com/creator/v2.1/data/jason18/zylker-store/report/All_Orders/3888833000000114027"
-X DELETE
-H 'Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf'  
-H 'environment: development'
-H 'demo_user_name: demouser_1'

Sample Input

Copied{
  "skip_workflow": ["form_workflow"],
  "result": {
    "message": true,
    "tasks": true
  }
}

Sample Response

Copied{
    "code": 3000,
    "data": {
        "ID": 3888833000000114027
    },
    "message": "Record Deleted Successfully!"
}

Sample value for the parameter "skip_workflow"	Description
"skip_workflow" : ["form_workflow"]	Prevents the associated form workflows from being triggered when the record is deleted using API