> ## 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: Roles Update Role

> Change one Zoho CRM role's name, parent role or settings. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Change one Zoho CRM role's name, parent role or settings.

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

## 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_roles_update_role',
  {
    "role": 123,
    "roles": [
      {
        "name": "Example"
      }
    ]
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_roles_update_role --input '{
  "role": 123,
  "roles": [
    {
      "name": "Example"
    }
  ]
}' --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": {
    "roles": [
      {
        "code": "SUCCESS",
        "details": {
          "id": "id_123"
        },
        "message": "Example message",
        "status": "success"
      }
    ]
  }
}
```

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

## Input reference

Request body for updating a role

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.role` | `integer` | Yes | — | The unique identifier of the role Format: `int64`. |
| `payload.roles` | `array` | Yes | — | Array of role objects 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 role",
    "properties": {
      "role": {
        "type": "integer",
        "description": "The unique identifier of the role",
        "format": "int64"
      },
      "roles": {
        "type": "array",
        "description": "Array of role objects to update",
        "maxItems": 1,
        "items": {
          "type": "object",
          "description": "Role object with updated values",
          "properties": {
            "reporting_to": {
              "type": "object",
              "description": "Parent role information",
              "properties": {
                "id": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Unique identifier of the parent role",
                  "maxLength": 19
                }
              },
              "additionalProperties": false
            },
            "share_with_peers": {
              "type": "boolean",
              "description": "Whether this role can share data with peer roles"
            },
            "description": {
              "type": [
                "string",
                "null"
              ],
              "description": "Detailed description of the role",
              "maxLength": 250
            },
            "name": {
              "type": "string",
              "description": "Display name of the role",
              "maxLength": 200
            }
          },
          "required": [
            "name"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "role",
      "roles"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Response for successful role update |
| `result.data.roles` | `array` | Yes | — | Array of update results Maximum items: 1. |
| `result.data.roles[].code` | `"SUCCESS"` | Yes | — | Operation result code Allowed: `SUCCESS`. |
| `result.data.roles[].details` | `object` | Yes | — | Additional details about the operation |
| `result.data.roles[].details.id` | `string` | Yes | — | Unique identifier of the updated role Maximum length: 19. |
| `result.data.roles[].message` | `string` | Yes | — | Human readable success message Maximum length: 100. |
| `result.data.roles[].status` | `"success"` | Yes | — | Operation status 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 successful role update",
        "properties": {
          "roles": {
            "type": "array",
            "description": "Array of update results",
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "Individual update result",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Operation result code",
                  "enum": [
                    "SUCCESS"
                  ]
                },
                "details": {
                  "type": "object",
                  "description": "Additional details about the operation",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Unique identifier of the updated role",
                      "maxLength": 19
                    }
                  },
                  "required": [
                    "id"
                  ],
                  "additionalProperties": false
                },
                "message": {
                  "type": "string",
                  "description": "Human readable success message",
                  "maxLength": 100
                },
                "status": {
                  "type": "string",
                  "description": "Operation status",
                  "enum": [
                    "success"
                  ]
                }
              },
              "required": [
                "code",
                "details",
                "message",
                "status"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "roles"
        ],
        "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.