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.

Table of Contents

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>/api/v2.1/<account_owner_name>/<app_link_name>/report/<report_link_name>/<record_ID>

Request method

DELETE

Header

KeyValueDescription
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.
environmentdevelopment/stage

Refers to the environment stage.

demo_user_namedemouser_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_urlthe base URL of your ZohoCreator account
For example, it's creator.zoho.com if your account belongs to Zoho's US DC, and is creator.zoho.eu if it belongs to Zoho's EU DC.
account_owner_namethe username of the Creator account's owner
app_link_namethe link name of the target application
report_link_namethe link name of the target report
record_IDthe 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)

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

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://appcreatordemo.manageengine.com/api/v2.1/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!"
}