> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Zoho CRM: Users Transfer User Transfer API

> Move a Zoho CRM user's records and settings to another user. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Move a Zoho CRM user's records and settings to another user.

> [!NOTE]
>
> Tool ID: `zoho_crm_users_transfer_user_transfer_api`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_users_transfer_user_transfer_api',
  {
    "userId": "user_123",
    "transfer": [
      {
        "move_subordinate": {
          "id": "id_123"
        },
        "transfer": {
          "id": "id_123"
        }
      }
    ]
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_users_transfer_user_transfer_api --input '{
  "userId": "user_123",
  "transfer": [
    {
      "move_subordinate": {
        "id": "id_123"
      },
      "transfer": {
        "id": "id_123"
      }
    }
  ]
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "transfer": [
      {
        "status": "example",
        "code": "SCHEDULED",
        "message": "Example message",
        "details": {
          "job_id": "job_123"
        }
      }
    ]
  }
}
```

Use `deepline describe zoho_crm_users_transfer_user_transfer_api --json` for the latest machine-readable contract.

## Input reference

Request body for transferring user data

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.userId` | `string` | Yes | — | User ID to be transferred and deleted Format: `int64`. |
| `payload.transfer` | `array` | Yes | — | Array of transfer operations Maximum items: 1. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Request body for transferring user data",
    "properties": {
      "userId": {
        "type": "string",
        "description": "User ID to be transferred and deleted",
        "format": "int64"
      },
      "transfer": {
        "type": "array",
        "description": "Array of transfer operations",
        "maxItems": 1,
        "items": {
          "type": "object",
          "description": "Transfer operation details",
          "properties": {
            "move_subordinate": {
              "type": "object",
              "description": "Details of the user to whom subordinates will be moved",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "User ID to move subordinates to",
                  "maxLength": 19
                }
              },
              "required": [
                "id"
              ],
              "additionalProperties": false
            },
            "transfer": {
              "type": "object",
              "description": "Transfer settings for records, assignments, and criteria",
              "properties": {
                "records": {
                  "type": "boolean",
                  "description": "Whether to transfer records"
                },
                "assignment": {
                  "type": "boolean",
                  "description": "Whether to transfer assignments"
                },
                "criteria": {
                  "type": "boolean",
                  "description": "Whether to transfer criteria"
                },
                "id": {
                  "type": "string",
                  "description": "User ID to transfer data to",
                  "maxLength": 19
                }
              },
              "required": [
                "id"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "move_subordinate",
            "transfer"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "userId",
      "transfer"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Response body for successful user transfer operation |
| `result.data.transfer` | `array` | Yes | — | Array containing transfer operation results Maximum items: 1. |
| `result.data.transfer[].status` | `string` | Yes | — | Status of the operation Maximum length: 100. |
| `result.data.transfer[].code` | `"SCHEDULED"` | Yes | — | Response code indicating operation scheduled Allowed: `SCHEDULED`. |
| `result.data.transfer[].message` | `string` | Yes | — | Human-readable message describing the result Maximum length: 500. |
| `result.data.transfer[].details` | `object` | Yes | — | Additional details about the scheduled operation |
| `result.data.transfer[].details.job_id` | `string` | Yes | — | Unique identifier for the scheduled job Maximum length: 19. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Response body for successful user transfer operation",
        "properties": {
          "transfer": {
            "type": "array",
            "description": "Array containing transfer operation results",
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "Transfer operation result",
              "properties": {
                "status": {
                  "type": "string",
                  "description": "Status of the operation",
                  "maxLength": 100
                },
                "code": {
                  "type": "string",
                  "description": "Response code indicating operation scheduled",
                  "enum": [
                    "SCHEDULED"
                  ]
                },
                "message": {
                  "type": "string",
                  "description": "Human-readable message describing the result",
                  "maxLength": 500
                },
                "details": {
                  "type": "object",
                  "description": "Additional details about the scheduled operation",
                  "properties": {
                    "job_id": {
                      "type": "string",
                      "description": "Unique identifier for the scheduled job",
                      "maxLength": 19
                    }
                  },
                  "required": [
                    "job_id"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "status",
                "code",
                "message",
                "details"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "transfer"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.