> ## 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: Recycle Bin Restore Recycle Bin Records

> Restore several deleted records, or all of them, from the Zoho CRM recycle bin. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

Restore several deleted records, or all of them, from the Zoho CRM recycle bin.

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

## 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_recycle_bin_restore_recycle_bin_records',
  {
    "ids": [
      "id_123"
    ],
    "filters": {
      "group_operator": "AND",
      "group": [
        {
          "field": {
            "api_name": "Example"
          },
          "comparator": "example",
          "value": {}
        }
      ]
    },
    "restore_all_records": true
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_recycle_bin_restore_recycle_bin_records --input '{
  "ids": [
    "id_123"
  ],
  "filters": {
    "group_operator": "AND",
    "group": [
      {
        "field": {
          "api_name": "Example"
        },
        "comparator": "example",
        "value": {}
      }
    ]
  },
  "restore_all_records": true
}' --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": {
    "recycle_bin": [
      {
        "status": "success",
        "code": "example",
        "message": "Example message",
        "details": {}
      }
    ]
  }
}
```

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

## Input reference

Request payload for restoring recycle bin records.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.ids` | `array` | No | — | Array of recycle bin record IDs to restore. Mutually exclusive with `filters` and `restore_all_records`. Maximum items: 200. |
| `payload.filters` | `object` | No | — | Filter criteria to select records for restoration. Mutually exclusive with `ids` and `restore_all_records`. Only 'AND' group operator is supported. |
| `payload.restore_all_records` | `boolean` | No | — | If set to true, restores all records in the recycle bin. Mutually exclusive with `ids` and `filters`. If set to false, either `ids` or `filters` must be provided. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Request payload for restoring recycle bin records.",
    "properties": {
      "ids": {
        "type": "array",
        "description": "Array of recycle bin record IDs to restore. Mutually exclusive with `filters` and `restore_all_records`.",
        "maxItems": 200,
        "items": {
          "type": "string",
          "description": "Recycle bin record identifier.",
          "maxLength": 100
        }
      },
      "filters": {
        "type": "object",
        "description": "Filter criteria to select records for restoration. Mutually exclusive with `ids` and `restore_all_records`. Only 'AND' group operator is supported.",
        "properties": {
          "group_operator": {
            "type": "string",
            "description": "Logical operator for combining filter conditions. Only 'AND' is supported.",
            "enum": [
              "AND"
            ]
          },
          "group": {
            "type": "array",
            "description": "Array of filter conditions.",
            "maxItems": 20,
            "items": {
              "type": "object",
              "description": "Individual filter condition.",
              "properties": {
                "field": {
                  "type": "object",
                  "description": "Field to filter on.",
                  "properties": {
                    "api_name": {
                      "type": "string",
                      "description": "API name of the field (e.g., 'display_name', 'module').",
                      "maxLength": 100
                    }
                  },
                  "required": [
                    "api_name"
                  ],
                  "additionalProperties": false
                },
                "comparator": {
                  "type": "string",
                  "description": "Comparison operator (e.g., 'equal', 'contains').",
                  "maxLength": 50
                },
                "value": {
                  "type": "object",
                  "description": "Value to compare against.",
                  "additionalProperties": true
                }
              },
              "required": [
                "field",
                "comparator",
                "value"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "group_operator",
          "group"
        ],
        "additionalProperties": false
      },
      "restore_all_records": {
        "type": "boolean",
        "description": "If set to true, restores all records in the recycle bin. Mutually exclusive with `ids` and `filters`. If set to false, either `ids` or `filters` must be provided."
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | List of results from the operation. |
| `result.data.recycle_bin` | `array` | Yes | — | Array of result items. Maximum items: 200. |
| `result.data.recycle_bin[].status` | `"success" \| "error"` | Yes | — | Per-item status Allowed: `success`, `error`. |
| `result.data.recycle_bin[].code` | `string` | Yes | — | Machine-readable result code Maximum length: 100. |
| `result.data.recycle_bin[].message` | `string` | Yes | — | Human-readable message Maximum length: 500. |
| `result.data.recycle_bin[].details` | `record` | Yes | — | Optional additional details about the item |
| `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": "List of results from the operation.",
        "properties": {
          "recycle_bin": {
            "type": "array",
            "description": "Array of result items.",
            "maxItems": 200,
            "items": {
              "type": "object",
              "description": "Individual result item with status and details.",
              "properties": {
                "status": {
                  "type": "string",
                  "description": "Per-item status",
                  "enum": [
                    "success",
                    "error"
                  ]
                },
                "code": {
                  "type": "string",
                  "description": "Machine-readable result code",
                  "maxLength": 100
                },
                "message": {
                  "type": "string",
                  "description": "Human-readable message",
                  "maxLength": 500
                },
                "details": {
                  "type": "object",
                  "description": "Optional additional details about the item",
                  "additionalProperties": true
                }
              },
              "required": [
                "status",
                "code",
                "message",
                "details"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "recycle_bin"
        ],
        "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.