Delete Global Picklist

Purpose

To delete a global picklist configured in your Zoho CRM account.

Request Details

Request URL

{api-domain}/crm/{version}/settings/global_picklists/{global_picklist_id}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

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

Supported modules

Leads, Contacts, Accounts, Campaigns, Cases, Invoices, Deals, Price Books, Products, Purchase Orders, Quotes, Sales Orders, Solutions, Vendors, Calls, Tasks, Events, Users, DealHistory, QuotedItems, OrderedItems, PurchaseItems, InvoicedItems, Visits, Services, Appointments, and Custom. 

Parameter

  • idsstring, optional

    It represents the unique ID of the global picklist that you want to delete. Skip this parameter if you have specified the id in the request URL.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v6/settings/global_picklists/2423488000000725001"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Possible Errors

  • INVALID_DATAHTTP 400
    • Given global picklist ID seems to be invalid

    Resolution: Specify a valid global picklist ID.

  • NOT_ALLOWEDHTTP 400
    • The provided global picklist ID is already scheduled for deletion
    • Global picklists limit exceeded

    Resolutions:

    • The global picklist has already been scheduled for deletion. Please provide another valid global picklist ID.
    • Reach out to our support team at support@zohocrm.com.
  • INVALID_REQUEST_METHODHTTP 400

    The https 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 a global picklist field. Create a valid token with required scopes. Refer to the 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{
    "global_picklists": [
        {
            "code": "SCHEDULED",
            "details": {
                "job_id": "111111000000201021"
            },
            "message": "global picklist delete scheduled successfully",
            "status": "success"
        }
    ]
}