Delete Field Update

Purpose

To delete field updates available in your Zoho CRM account.

Endpoints

DELETE /settings/automation/field_updates/{field_update_ID}
DELETE /settings/automation/field_updates/{field_id}?ids={field_update_ID_1},{field_update_ID_2},...

Request Details

Request URL

To delete a single field update action:
{api-domain}/crm/{version}/settings/automation/field_updates/{field_update_ID}
To delete multiple field update actions:
{api-domain}/crm/{version}/settings/automation/field_updates/{field_id}?ids={field_update_ID_1},{field_update_ID_2},...

Supported modules

Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Appointments, and Custom.

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.automation_actions.DELETE

Parameter

ids JSON object, mandatory to delete multiple field updates
The unique field update IDs you want to delete. Use the Get Field Update API to get the field update IDs.

Note

You can delete field updates only if they are not associated with automation actions such as Workflows, Approval Processes, or Blueprints. You can find the field update action associations in the "feature_type" key of the Get Field Update API.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/automation/field_updates/5725767000001771001"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Possible Errors

INVALID_DATAHTTP 400
The ID given seems to be invalid
Resolution: Specify a valid field update ID to delete. Use the Get Field Update API to get the field update IDs.
NOT_ALLOWEDHTTP 400
Specified field update ID deletion is not allowed
Resolution: The specified field update ID is associated with automation actions such as Workflow, Approval Process, and Blueprint.
REQUIRED_PARAM_MISSINGHTTP 400
Required parameter is missing
Resolution: Please specify the ids parameter when you want to delete multiple field updates per API call.
INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL.
Specify a valid request method. Refer to Endpoints section for details.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: The client does not have a valid scope to delete field updates. Create a new token with valid scope. Refer to Scope section for details.
AUTHENTICATION_FAILUREHTTP 401
Authentication failed
Resolution: Pass the access token in the request header of the API call.
INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to Request URL section for details.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in the server. Contact support team.

Sample Response

Copied{
    "field_updates": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "5725767000001771001"
            },
            "message": "field update deleted successfully",
            "status": "success"
        }
    ]
}