Delete Record by ID
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.
OpenAPI Specification
The OpenAPI Specification(OAS) is the most widely used standard for API description and refers to a standard interface for describing REST APIs.Download the OAS for the Delete Record by ID API below:
Request Details
Request URL
https://<base_url
Request method
DELETE
Header
Key | Value | Description |
Authorization | Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf | 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. |
OAuth scope
scope=ZohoCreator.report.DELETE
where,
base_url | Zoho Creator: The base URL of your Creator 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. Zoho Creator On-premise: The base URL specific to your Zoho Creator On-premise account. This URL will be either https://host_name:port_number (learn more) or the hostname of the server where Creator On-prem is running. |
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 |
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:
- 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"
This key will contain the ID of the deleted record.
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/jason18/zylker-store/form/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/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{
"result": {
"message": true,
"tasks": true
}
}
Sample Response
Copied{
"code": 3000,
"data": {
"ID": 3888833000000114027
},
"message": "Record Deleted Successfully!"
}