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

> Update Workflow Rule By ID. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

Update Workflow Rule By ID.

<Info>
  Tool ID: `zoho_crm_workflow_rules_update_workflow_rule_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_workflow_rules_update_workflow_rule_by_id',
  {
    "id": "id_123",
    "workflow_rules": [
      {
        "id": "id_123",
        "status": {
          "active": true,
          "delete_schedule_action": true
        },
        "execute_when": {}
      }
    ]
  },
);

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

### CLI

```bash theme={null}
deepline tools execute zoho_crm_workflow_rules_update_workflow_rule_by_id --input '{
  "id": "id_123",
  "workflow_rules": [
    {
      "id": "id_123",
      "status": {
        "active": true,
        "delete_schedule_action": true
      },
      "execute_when": {}
    }
  ]
}' --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "workflow_rules": [
      {
        "code": "example",
        "details": {
          "id": "id_123"
        },
        "message": "workflow created"
      }
    ]
  }
}
```

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

## Input reference

Request body schema

| Name                     | Type     | Required | Default | Details                                                                                                                                        |
| ------------------------ | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.id`             | `string` | Yes      | —       | Single ID of a workflow rule. Format: `string`.                                                                                                |
| `payload.workflow_rules` | `array`  | Yes      | —       | The request body must contain a workflow\_rules array. You can include only one object in this array per request. (Required) Maximum items: 1. |

<Info>
  This input schema is too large to embed without slowing the page. Get the complete live contract with `deepline tools get zoho_crm_workflow_rules_update_workflow_rule_by_id --json`.
</Info>

## Output reference

Standard tool result payload.

| Name                                      | Type                                                                                                                                                                         | Required | Default | Details                                                                                                                                                                                   |
| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `result.data`                             | `object`                                                                                                                                                                     | Yes      | —       | Workflow Rule created successfully                                                                                                                                                        |
| `result.data.workflow_rules`              | `array`                                                                                                                                                                      | No       | —       | Field: workflow\_rules Maximum items: 200.                                                                                                                                                |
| `result.data.workflow_rules[].code`       | `string`                                                                                                                                                                     | No       | —       | Field: code Maximum length: 255.                                                                                                                                                          |
| `result.data.workflow_rules[].details`    | `object`                                                                                                                                                                     | No       | —       | Nested schema for details                                                                                                                                                                 |
| `result.data.workflow_rules[].details.id` | `string`                                                                                                                                                                     | No       | —       | Field: id Maximum length: 255.                                                                                                                                                            |
| `result.data.workflow_rules[].message`    | `"workflow created" \| "workflow updated" \| "workflow deleted" \| "WorkFlow Rule deleted successfully" \| "rules reordered successfully" \| "Workflow cloned successfully"` | No       | —       | Field: message Allowed: `workflow created`, `workflow updated`, `workflow deleted`, `WorkFlow Rule deleted successfully`, `rules reordered successfully`, `Workflow cloned successfully`. |
| `result.data.workflow_rules[].status`     | `string`                                                                                                                                                                     | No       | —       | Field: status Maximum length: 7.                                                                                                                                                          |
| `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": "Workflow Rule created successfully",
        "properties": {
          "workflow_rules": {
            "type": "array",
            "description": "Field: workflow_rules",
            "maxItems": 200,
            "items": {
              "type": "object",
              "description": "Nested schema for workflow_rules",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Field: code",
                  "maxLength": 255
                },
                "details": {
                  "type": "object",
                  "description": "Nested schema for details",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Field: id",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                },
                "message": {
                  "type": "string",
                  "description": "Field: message",
                  "enum": [
                    "workflow created",
                    "workflow updated",
                    "workflow deleted",
                    "WorkFlow Rule deleted successfully",
                    "rules reordered successfully",
                    "Workflow cloned successfully"
                  ]
                },
                "status": {
                  "type": "string",
                  "description": "Field: status",
                  "maxLength": 7
                }
              },
              "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)