Feature-specific Info

Purpose

To get details about the record(s) that you assigned territories to or removed territories from.

Endpoints

Request Details

Request URL

{api-domain}/crm/{version}/{module_api_name}/actions/get_feature_specific_info

Supported modules

Leads, Accounts, Contacts, and Deals

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.modules.ALL/READ

Possible module names

leads, accounts, contacts, and deals

Parameters

  • idsoptional

    Represents the unique IDs of the records you assigned territories to or removed territories from. You can specify a maximum of 100 record IDs separated by commas. Instead of using this parameter, you can also include the record ID in the request URL after the module's API name. Example: crm/{version}/{module_api_name}/{record_id}actions/get_feature_specific_info.

  • featuresoptional

    Represents the feature about which you want to fetch the details. To get the details of records whose territory assignment or removal was schedules, the value is territory_scheduled_jobs.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v6/Accounts/actions/get_feature_specific_info?features=territory_scheduled_jobs&ids= 554023000003635023"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d @removeterritories.json
-X GET

Response JSON Keys

  • job_idstring

    Represents the job ID that was created when you assigned or removed territories.

  • sourcestring
    • Represents how the job was scheduled while assigning or removing territories. The possible values are:
      • creation - The job was scheduled when the records were created in the module with territory rules in place.
      • update - The job was scheduled when the records were updated in the module with territory rules in place.
      • manual_territory_removal - The job was scheduled when you used the Remove territories API to manually remove territories of records.
      • manual_territory_assignment - The job was scheduled when you used the Assign territories API to manually assign territories to records.
  • statusstring

    Represents the status of territory assignment or removal job. The possible values are SCHEDULED and FAILED.

  • typestring

    The value territory_scheduled_jobs represents that this job was scheduled owing to territory assignment and removal.

  • idstring

    The ID of the record that was assigned or removed territories from.

Possible Errors

  • 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.

  • TERRITORY_DISABLEDHTTP 400

    Territory is disabled for this module.
    Resolution: Enable territory management in the module. If you want to have territory rules for the Leads module, contact support@zohocrm.com.

  • INVALID_DATAHTTP 400

    The record ID in the URL or the "ids" parameter is invalid.
    Resolution: Specify right IDs for the records in the URL or the "ids" parameter. If the record ID in the "ids" parameter is invalid, the "details" key in the response will have the "id" key that contains the invalid ID. If the record ID is in the URL, the details key will have the "resource_path_index" that shows the index of invalid data in the URL.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Invalid OAuth scope to access this URL
    Resolution: Client does not have ZohoCRM.modules.{module_name}.ALL/READ scope. Create a new client with the valid scope. Refer to scope section above.

  • INTERNAL_ERRORHTTP 500

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

Sample Response

Copied{
    "data": [
        {
            "features_info": [
                {
                    "details": [
                        {
                            "job_id": "554023000003908007",
                            "source": "manual_territory_assignment",
                            "status": "SCHEDULED"
                        }
                    ],
                    "type": "territory_scheduled_jobs"
                }
            ],
            "id": "554023000003635023"
        }
    ]
}