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

> PUT by variable_groups by id. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

PUT by variable\_groups by id.

<Info>
  Tool ID: `zoho_crm_variable_groups_put_variable_group_by_id`
</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_variable_groups_put_variable_group_by_id',
  {
    "id": "id_123",
    "variable_groups": [
      {
        "name": "Example",
        "description": "Example description",
        "api_name": "Example"
      }
    ]
  },
);

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

### CLI

```bash theme={null}
deepline tools execute zoho_crm_variable_groups_put_variable_group_by_id --input '{
  "id": "id_123",
  "variable_groups": [
    {
      "name": "Example",
      "description": "Example description",
      "api_name": "Example"
    }
  ]
}' --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "variable_groups": [
      {
        "code": "example",
        "details": {
          "id": "id_123",
          "rid": "example",
          "api_name": "Example"
        },
        "message": "Example message"
      }
    ]
  }
}
```

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

## Input reference

Alternate request wrapper containing the variable\_groups array for defining or updating variable group metadata.

| Name                      | Type     | Required | Default | Details                                                      |
| ------------------------- | -------- | -------- | ------- | ------------------------------------------------------------ |
| `payload.id`              | `string` | Yes      | —       | variable groups id in url path Maximum length: 255.          |
| `payload.variable_groups` | `array`  | Yes      | —       | Root key name (Required) Minimum items: 1. Maximum items: 1. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Alternate request wrapper containing the variable_groups array for defining or updating variable group metadata.",
    "properties": {
      "id": {
        "type": "string",
        "description": "variable groups id in url path",
        "maxLength": 255
      },
      "variable_groups": {
        "type": "array",
        "description": "Root key name (Required)",
        "minItems": 1,
        "maxItems": 1,
        "items": {
          "type": "object",
          "description": "Alternate schema instance for variable group definition with name, description, and api_name.",
          "properties": {
            "name": {
              "type": [
                "string",
                "null"
              ],
              "description": "variable group name",
              "maxLength": 50
            },
            "description": {
              "type": [
                "string",
                "null"
              ],
              "description": "description of the variable group",
              "maxLength": 3000
            },
            "api_name": {
              "type": [
                "string",
                "null"
              ],
              "description": "variable group api name",
              "maxLength": 100
            }
          },
          "additionalProperties": false
        }
      }
    },
    "required": [
      "id",
      "variable_groups"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                                             | Type     | Required | Default | Details                                                                                                          |
| ------------------------------------------------ | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------- |
| `result.data`                                    | `object` | Yes      | —       | Successful response containing variable\_groups with per-item operation statuses for the requested action.       |
| `result.data.variable_groups`                    | `array`  | No       | —       | Field: variable\_groups Maximum items: 1.                                                                        |
| `result.data.variable_groups[].code`             | `string` | No       | —       | Field: code Maximum length: 255.                                                                                 |
| `result.data.variable_groups[].details`          | `object` | No       | —       | Details identifying the field (api\_name) and its json\_path within the payload for context in per-item results. |
| `result.data.variable_groups[].details.id`       | `string` | No       | —       | Field: id Maximum length: 255.                                                                                   |
| `result.data.variable_groups[].details.rid`      | `string` | No       | —       | Field: rid Maximum length: 255.                                                                                  |
| `result.data.variable_groups[].details.api_name` | `string` | No       | —       | Field: api\_name Maximum length: 255.                                                                            |
| `result.data.variable_groups[].message`          | `string` | No       | —       | Field: message Maximum length: 255.                                                                              |
| `result.data.variable_groups[].status`           | `string` | No       | —       | Field: status Maximum length: 255.                                                                               |
| `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": "Successful response containing variable_groups with per-item operation statuses for the requested action.",
        "properties": {
          "variable_groups": {
            "type": "array",
            "description": "Field: variable_groups",
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "Per-item result for a variable group operation, including code, message, status, and contextual details.",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Field: code",
                  "maxLength": 255
                },
                "details": {
                  "type": "object",
                  "description": "Details identifying the field (api_name) and its json_path within the payload for context in per-item results.",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Field: id",
                      "maxLength": 255
                    },
                    "rid": {
                      "type": "string",
                      "description": "Field: rid",
                      "maxLength": 255
                    },
                    "api_name": {
                      "type": "string",
                      "description": "Field: api_name",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                },
                "message": {
                  "type": "string",
                  "description": "Field: message",
                  "maxLength": 255
                },
                "status": {
                  "type": "string",
                  "description": "Field: status",
                  "maxLength": 255
                }
              },
              "additionalProperties": false
            }
          }
        },
        "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)