> ## 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: Portal Users Change Portal Users Status Bulk

> Activate or deactivate several Zoho CRM portal users at once. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Activate or deactivate several Zoho CRM portal users at once.

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

## 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_portal_users_change_portal_users_status_bulk',
  {
    "portal": "example",
    "userType": "example",
    "change_status": [
      {
        "users": [
          {
            "active": true,
            "personality_id": "personality_123"
          }
        ]
      }
    ]
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_portal_users_change_portal_users_status_bulk --input '{
  "portal": "example",
  "userType": "example",
  "change_status": [
    {
      "users": [
        {
          "active": true,
          "personality_id": "personality_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": {
    "change_status": [
      {
        "code": "SCHEDULED",
        "details": {
          "job_id": "job_123"
        },
        "message": "Example message",
        "status": "success"
      }
    ]
  }
}
```

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

## Input reference

Request body for changing status of portal users

| 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.change_status` | `array` | Yes | — | List of portal user change status requests Maximum items: 100. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Request body for changing status of portal users",
    "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
      },
      "change_status": {
        "type": "array",
        "description": "List of portal user change status requests",
        "maxItems": 100,
        "items": {
          "type": "object",
          "description": "Portal user change status request object",
          "properties": {
            "users": {
              "type": "array",
              "description": "List of portal user change status requests",
              "maxItems": 100,
              "items": {
                "type": "object",
                "description": "Portal user change status request object",
                "properties": {
                  "active": {
                    "type": "boolean",
                    "description": "Status of portal user"
                  },
                  "personality_id": {
                    "type": "string",
                    "description": "Record id of portal user",
                    "maxLength": 255
                  }
                },
                "required": [
                  "personality_id",
                  "active"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "users"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "portal",
      "userType",
      "change_status"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Response for status change of portal users requests |
| `result.data.change_status` | `array` | Yes | — | List of status changed portal users responses Maximum items: 100. |
| `result.data.change_status[].code` | `"SCHEDULED"` | Yes | — | Status code indicating portal user status was changed Allowed: `SCHEDULED`. |
| `result.data.change_status[].details` | `object` | Yes | — | Additional details about the portal user status was changed |
| `result.data.change_status[].details.job_id` | `string` | Yes | — | Record id of portal user Maximum length: 255. |
| `result.data.change_status[].message` | `string` | Yes | — | Success message Maximum length: 1000. |
| `result.data.change_status[].status` | `"success"` | Yes | — | Status of the response Allowed: `success`. |
| `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 for status change of portal users requests",
        "properties": {
          "change_status": {
            "type": "array",
            "description": "List of status changed portal users responses",
            "maxItems": 100,
            "items": {
              "type": "object",
              "description": "Portal change status response object",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Status code indicating portal user status was changed",
                  "enum": [
                    "SCHEDULED"
                  ]
                },
                "details": {
                  "type": "object",
                  "description": "Additional details about the portal user status was changed",
                  "properties": {
                    "job_id": {
                      "type": "string",
                      "description": "Record id of portal user",
                      "maxLength": 255
                    }
                  },
                  "required": [
                    "job_id"
                  ],
                  "additionalProperties": false
                },
                "message": {
                  "type": "string",
                  "description": "Success message",
                  "maxLength": 1000
                },
                "status": {
                  "type": "string",
                  "description": "Status of the response",
                  "enum": [
                    "success"
                  ]
                }
              },
              "required": [
                "code",
                "details",
                "message",
                "status"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "change_status"
        ],
        "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.