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

> Change status of portal users. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

Change status of portal users.

<Info>
  Tool ID: `zoho_crm_portal_users_change_portal_users_status`
</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_change_portal_users_status',
  {
    "portal": "example",
    "userType": "example",
    "recordId": "record_123",
    "active": true
  },
);

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

### CLI

```bash theme={null}
deepline tools execute zoho_crm_portal_users_change_portal_users_status --input '{
  "portal": "example",
  "userType": "example",
  "recordId": "record_123",
  "active": true
}' --json
```

## Example response

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

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

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

## Input reference

Changing portal users status.

| 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.recordId` | `string`  | Yes      | —       | The unique identifier of the record Maximum length: 255.  |
| `payload.active`   | `boolean` | Yes      | —       | The unique identifier of the record                       |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Changing portal users status.",
    "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
      },
      "recordId": {
        "type": "string",
        "description": "The unique identifier of the record",
        "maxLength": 255
      },
      "active": {
        "type": "boolean",
        "description": "The unique identifier of the record"
      }
    },
    "required": [
      "portal",
      "userType",
      "recordId",
      "active"
    ],
    "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`                   | `"SUCCESS"` | Yes      | —       | Status code indicating portal user status was changed Allowed: `SUCCESS`. |
| `result.data.change_status[].details`                | `object`    | Yes      | —       | Additional details about the portal user status was changed               |
| `result.data.change_status[].details.personality_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={null}
  {
    "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": [
                    "SUCCESS"
                  ]
                },
                "details": {
                  "type": "object",
                  "description": "Additional details about the portal user status was changed",
                  "properties": {
                    "personality_id": {
                      "type": "string",
                      "description": "Record id of portal user",
                      "maxLength": 255
                    }
                  },
                  "required": [
                    "personality_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](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)