> ## 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: Workflow Rules Update Workflow Rule By ID

> Change one Zoho CRM workflow rule's trigger, criteria or actions by its ID. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

Change one Zoho CRM workflow rule's trigger, criteria or actions by its ID.

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

## 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_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={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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 returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "workflow_rules": [
      {
        "code": "example",
        "details": {
          "id": "id_123"
        },
        "message": "workflow created"
      }
    ]
  }
}
```

Use `deepline describe 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. |

> [!NOTE]
>
> This input schema is too large for an inline display. Read the complete live contract with `deepline describe zoho_crm_workflow_rules_update_workflow_rule_by_id --json`.

## 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={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "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](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.