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

> Create new roles. Zoho CRM Roles Create Roles reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

Create new roles.

<Info>
  Tool ID: `zoho_crm_roles_create_roles`
</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_roles_create_roles',
  {
    "roles": [
      {
        "reporting_to": {
          "id": "id_123"
        },
        "name": "Example"
      }
    ]
  },
);

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

### CLI

```bash theme={null}
deepline tools execute zoho_crm_roles_create_roles --input '{
  "roles": [
    {
      "reporting_to": {
        "id": "id_123"
      },
      "name": "Example"
    }
  ]
}' --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "roles": [
      {
        "code": "SUCCESS",
        "details": {
          "id": "id_123"
        },
        "message": "Example message",
        "status": "success"
      }
    ]
  }
}
```

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

## Input reference

Request body for creating roles

| Name            | Type    | Required | Default | Details                                             |
| --------------- | ------- | -------- | ------- | --------------------------------------------------- |
| `payload.roles` | `array` | Yes      | —       | Array of role objects to create Maximum items: 100. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Request body for creating roles",
    "properties": {
      "roles": {
        "type": "array",
        "description": "Array of role objects to create",
        "maxItems": 100,
        "items": {
          "type": "object",
          "description": "Role object to create",
          "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",
                "null"
              ],
              "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",
            "reporting_to"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "roles"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                             | Type        | Required | Default | Details                                                   |
| -------------------------------- | ----------- | -------- | ------- | --------------------------------------------------------- |
| `result.data`                    | `object`    | Yes      | —       | Response for successful role creation                     |
| `result.data.roles`              | `array`     | Yes      | —       | Array of creation results Maximum items: 100.             |
| `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 created 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={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Response for successful role creation",
        "properties": {
          "roles": {
            "type": "array",
            "description": "Array of creation results",
            "maxItems": 100,
            "items": {
              "type": "object",
              "description": "Individual creation 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 created 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](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)
