Validate before Transferring

Purpose

To validate whether or not the user has open records(records with open cases, tasks, calls, or meetings) in a territory before transferring them to a user in another territory.

Endpoints

Request Details

Request URL

To validate the records from all territories of a user: {api-domain}/crm/{version}/users/{id}/territories/actions/validate_before_transfer
To validate the records from a specific territory of a user: {api-domain}/crm/{version}/users/{id}/territories/{territory_id}/actions/validate_before_transfer

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.users.{operation_type}
(or)
scope=ZohoCRM.settings.territories.{operation_type}

Possible operation types

ALL - Full access to the record
READ - Get records from the module

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v5/users/3652397000000186017/territories/actions/validate_before_transfer"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X GET

Response JSON Keys

  • recordsboolean

    Represents whether the user has open records in that territory.

  • idstring

    Represents the unique ID of the territory.

  • namestring

    Represents the name of the territory.

Sample Response

Copied{
    "validate_before_transfer": [
        {
            "records": false,
            "id": "3652397000000715341",
            "Name": "USA"
        },
        {
            "records": false,
            "id": "3652397000007612003",
            "Name": "Texas"
        },
        {
            "records": true,
            "id": "3652397000007612015",
            "Name": "Washington"
        },
        {
            "records": false,
            "id": "3652397000007622003",
            "Name": "New York"
        }
    ]
}