> ## 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: User Groups Update Group

> Change a Zoho CRM user group's name, description or members. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Change a Zoho CRM user group's name, description or members.

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

## Run this action

This action has conditional or dynamic inputs. A static example cannot describe these inputs reliably.

Read the live contract before you execute this action:

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline describe zoho_crm_user_groups_update_group --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": {
    "user_groups": [
      {
        "code": "SUCCESS",
        "message": "Example message",
        "status": "success",
        "details": {
          "id": "id_123"
        }
      }
    ]
  }
}
```

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

## Input reference

Request body for updating a user group

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.group` | `"1234567890"` | Yes | — | The unique identifier of the user group Allowed: `1234567890`. |
| `payload.user_groups` | `array` | Yes | — | Array of user groups to update Maximum items: 1. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Request body for updating a user group",
    "properties": {
      "group": {
        "type": "string",
        "description": "The unique identifier of the user group",
        "enum": [
          "1234567890"
        ]
      },
      "user_groups": {
        "type": "array",
        "description": "Array of user groups to update",
        "maxItems": 1,
        "items": {
          "type": "object",
          "description": "User group update details",
          "properties": {
            "description": {
              "type": "object",
              "description": "Description of the user group",
              "additionalProperties": true
            },
            "name": {
              "type": "string",
              "description": "Name of the user group",
              "maxLength": 250
            },
            "sources": {
              "type": "array",
              "description": "Array of sources for the user group",
              "maxItems": 200,
              "items": {
                "type": "object",
                "description": "Source details for the user group",
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "Type of source",
                    "enum": [
                      "territories",
                      "roles",
                      "users"
                    ]
                  },
                  "source": {
                    "type": "object",
                    "description": "Source identifier",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "ID of the source",
                        "maxLength": 19
                      }
                    },
                    "required": [
                      "id"
                    ],
                    "additionalProperties": false
                  },
                  "subordinates": {
                    "type": "object",
                    "description": "Include subordinates flag",
                    "additionalProperties": true
                  },
                  "sub_territories": {
                    "type": "object",
                    "description": "Include sub-territories flag",
                    "additionalProperties": true
                  }
                },
                "required": [
                  "type",
                  "source"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "name",
            "sources"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "group",
      "user_groups"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Response for user group update |
| `result.data.user_groups` | `array` | Yes | — | Array of user group update results Maximum items: 1. |
| `result.data.user_groups[].code` | `"SUCCESS"` | Yes | — | Response code indicating success or scheduled status Allowed: `SUCCESS`. |
| `result.data.user_groups[].message` | `string` | Yes | — | Response message describing the result Maximum length: 500. |
| `result.data.user_groups[].status` | `"success"` | Yes | — | Status of the operation Allowed: `success`. |
| `result.data.user_groups[].details` | `object` | Yes | — | Details containing the created group ID |
| `result.data.user_groups[].details.id` | `string` | Yes | — | ID of the created user group Maximum length: 19. |
| `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 user group update",
        "properties": {
          "user_groups": {
            "type": "array",
            "description": "Array of user group update results",
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "User group update result details",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Response code indicating success or scheduled status",
                  "enum": [
                    "SUCCESS"
                  ]
                },
                "message": {
                  "type": "string",
                  "description": "Response message describing the result",
                  "maxLength": 500
                },
                "status": {
                  "type": "string",
                  "description": "Status of the operation",
                  "enum": [
                    "success"
                  ]
                },
                "details": {
                  "type": "object",
                  "description": "Details containing the created group ID",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "ID of the created user group",
                      "maxLength": 19
                    }
                  },
                  "required": [
                    "id"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "code",
                "message",
                "status",
                "details"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "user_groups"
        ],
        "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.