Delete Custom Fields

Purpose

To delete a custom field from a module in your Zoho CRM account.

Endpoints

Request Details

Request URL

{api-domain}/crm/{version}/settings/fields/{field_id}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.settings.fields.DELETE(or)
scope=ZohoCRM.settings.fields.ALL (or)
scope=ZohoCRM.settings.ALL 

Parameter

  • modulestring, mandatory

    Specify the module from which you want to delete custom fields, such as Leads or Contacts.

Note

You can delete custom fields, but not the system-defined fields.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v6/settings/fields/111116000000063101?module=Leads"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Possible Errors

  • INVALID_DATAHTTP 400

    The ID given seems to be ivalid
    Resolution: Specify a valid field ID.

  • NOT_ALLOWEDHTTP 400
    • The custom field has already used in other places
    • Only the custom fields can be deleted

    Resolutions:

    • You cannot delete a custom field that has been used in other places, such as workflows, scoring rules, approval processes, review processes, and so on.
    • You cannot delete system-defined fields. Please specify only valid custom fields.
  • REQUIRED_PARAM_MISSINGHTTP 400

    Required parameter is missing
    Resolution: Please specify the module parameter and its corresponding value.

  • INVALID_DATAHTTP 400

    The job_id is invalid.
    Resolution: Specify a valid job ID.

  • 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 the endpoints section above.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: The client does not have a valid scope to delete custom fields. Create a new token with valid scope. Refer to scope section above.

  • 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 the request URL section above.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in the server. Contact support team.

Sample Response

Copied{
    "fields": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "111116000000063101"
            },
            "message": "field deleted",
            "status": "success"
        }
    ]
}