> ## 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: README

> delete portal users. Zoho CRM Portal Users Delete Portal Users reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline.

delete portal users.

<Info>
  Tool ID: `zoho_crm_portal_users_delete_portal_users`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_portal_users_delete_portal_users',
  {
    "portal": "example",
    "userType": "example"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute zoho_crm_portal_users_delete_portal_users --input '{
  "portal": "example",
  "userType": "example"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "users": [
      {
        "code": "SUCCESS",
        "message": "Example message",
        "details": {
          "personality_id": "personality_123"
        },
        "status": "error"
      }
    ]
  }
}
```

Use `deepline tools get zoho_crm_portal_users_delete_portal_users --json` for the latest machine-readable contract.

## Input reference

Retrieve users of a specific portal filtered by user type.

| Name                      | Type      | Required | Default | Details                                                             |
| ------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------- |
| `payload.portal`          | `string`  | Yes      | —       | The unique identifier of the portal Maximum length: 255.            |
| `payload.userType`        | `string`  | Yes      | —       | The type of portal user to filter by Maximum length: 255.           |
| `payload.personality_ids` | `integer` | No       | —       | List for record IDs of portal users to be deleted. Format: `int32`. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieve users of a specific portal filtered by user type.",
    "properties": {
      "portal": {
        "type": "string",
        "description": "The unique identifier of the portal",
        "maxLength": 255
      },
      "userType": {
        "type": "string",
        "description": "The type of portal user to filter by",
        "maxLength": 255
      },
      "personality_ids": {
        "type": "integer",
        "description": "List for record IDs of portal users to be deleted.",
        "format": "int32"
      }
    },
    "required": [
      "portal",
      "userType"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                                         | Type                   | Required | Default | Details                                                         |
| -------------------------------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------- |
| `result.data`                                | `object`               | Yes      | —       | Response containing deleted portal users.                       |
| `result.data.users`                          | `array`                | Yes      | —       | List of deleted portal users Maximum items: 200.                |
| `result.data.users[].code`                   | `"SUCCESS"`            | Yes      | —       | Error code indicating no permission Allowed: `SUCCESS`.         |
| `result.data.users[].message`                | `string`               | Yes      | —       | Error message describing the issue Maximum length: 1000.        |
| `result.data.users[].details`                | `object`               | Yes      | —       | Additional error details                                        |
| `result.data.users[].details.personality_id` | `string`               | No       | —       | Unique identifier for the user personality Maximum length: 255. |
| `result.data.users[].status`                 | `"error" \| "success"` | Yes      | —       | Status of the response Allowed: `error`, `success`.             |
| `result.meta`                                | `object`               | No       | —       | Additional response metadata (status, paging).                  |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Response containing deleted portal users.",
        "properties": {
          "users": {
            "type": "array",
            "description": "List of deleted portal users",
            "maxItems": 200,
            "items": {
              "type": "object",
              "description": "Deleted portal user details",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Error code indicating no permission",
                  "enum": [
                    "SUCCESS"
                  ]
                },
                "message": {
                  "type": "string",
                  "description": "Error message describing the issue",
                  "maxLength": 1000
                },
                "details": {
                  "type": "object",
                  "description": "Additional error details",
                  "properties": {
                    "personality_id": {
                      "type": "string",
                      "description": "Unique identifier for the user personality",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                },
                "status": {
                  "type": "string",
                  "description": "Status of the response",
                  "enum": [
                    "error",
                    "success"
                  ]
                }
              },
              "required": [
                "code",
                "message",
                "details",
                "status"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "users"
        ],
        "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](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)