> ## 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: Pipeline Update Or Delete Pipeline Patch URL

> Update the stages or settings of one Zoho CRM deal pipeline by its ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Update the stages or settings of one Zoho CRM deal pipeline by its ID.

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

## 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_pipeline_update_or_delete_pipeline_patch_url',
  {
    "id": "id_123",
    "layout_id": "layout_123",
    "pipeline": [
      {
        "display_value": "example",
        "_delete": {
          "permanent": null
        },
        "default": true
      }
    ]
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_pipeline_update_or_delete_pipeline_patch_url --input '{
  "id": "id_123",
  "layout_id": "layout_123",
  "pipeline": [
    {
      "display_value": "example",
      "_delete": {
        "permanent": null
      },
      "default": true
    }
  ]
}' --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": {
    "pipeline": [
      {
        "code": "SUCCESS",
        "details": {
          "id": "id_123"
        },
        "message": "Example message",
        "status": "success"
      }
    ]
  }
}
```

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

## Input reference

Request body for updating or creating pipeline configurations with custom picklist values and stage mappings.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | Yes | — | Pipeline Id Format: `int64`. |
| `payload.layout_id` | `string` | Yes | — | Layout Id Format: `int64`. |
| `payload.pipeline` | `array` | Yes | — | Array of pipeline picklist configurations to create or update. Minimum items: 1. 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 or creating pipeline configurations with custom picklist values and stage mappings.",
    "properties": {
      "id": {
        "type": "string",
        "description": "Pipeline Id",
        "format": "int64"
      },
      "layout_id": {
        "type": "string",
        "description": "Layout Id",
        "format": "int64"
      },
      "pipeline": {
        "type": "array",
        "description": "Array of pipeline picklist configurations to create or update.",
        "minItems": 1,
        "maxItems": 1,
        "items": {
          "type": "object",
          "description": "Picklist value configuration for pipeline customization, including stage mappings.",
          "properties": {
            "display_value": {
              "type": "string",
              "description": "User-facing display name for the picklist value.",
              "format": "string"
            },
            "_delete": {
              "type": "object",
              "description": "Deletion metadata object.",
              "properties": {
                "permanent": {
                  "type": [
                    "null"
                  ],
                  "description": "Indicates if the deletion was permanent (true), soft delete (false), or status unknown/null."
                }
              },
              "required": [
                "permanent"
              ],
              "additionalProperties": false
            },
            "default": {
              "type": "boolean",
              "description": "Indicates if this picklist value should be set as the default option."
            },
            "maps": {
              "type": "array",
              "description": "Array of stage mappings defining which stages this picklist value connects to and their sequence.",
              "minItems": 1,
              "maxItems": 200,
              "items": {
                "type": "object",
                "description": "Mapping configuration for associating a picklist value with a specific pipeline stage.",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Unique identifier of the target pipeline stage to map.",
                    "format": "int64"
                  },
                  "display_value": {
                    "type": "string",
                    "description": "User-facing display name for the pipeline stage.",
                    "format": "string"
                  },
                  "_delete": {
                    "type": "object",
                    "description": "Deletion metadata object.",
                    "properties": {
                      "permanent": {
                        "type": [
                          "null"
                        ],
                        "description": "Indicates if the deletion was permanent (true), soft delete (false), or status unknown/null."
                      }
                    },
                    "required": [
                      "permanent"
                    ],
                    "additionalProperties": false
                  },
                  "sequence_number": {
                    "type": "integer",
                    "description": "Optional position of this stage mapping in the pipeline sequence (overrides default positioning).",
                    "format": "int32"
                  }
                },
                "required": [
                  "id"
                ],
                "additionalProperties": false
              }
            }
          },
          "additionalProperties": false
        }
      }
    },
    "required": [
      "id",
      "layout_id",
      "pipeline"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Batch success response for pipeline creation/update operations, maintaining 1:1 correspondence with request items. |
| `result.data.pipeline` | `array` | Yes | — | Array of individual success responses matching the request pipeline items. Minimum items: 1. Maximum items: 1. |
| `result.data.pipeline[].code` | `"SUCCESS"` | Yes | — | Machine-readable success code. Allowed: `SUCCESS`. |
| `result.data.pipeline[].details` | `object` | Yes | — | Operation-specific success details including resource identifiers. |
| `result.data.pipeline[].details.id` | `string` | Yes | — | Unique identifier of the newly created pipeline configuration. Format: `int64`. |
| `result.data.pipeline[].message` | `string` | Yes | — | Human-readable confirmation of the successful operation. Format: `string`. |
| `result.data.pipeline[].status` | `"success"` | Yes | — | Overall status indicator. 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": "Batch success response for pipeline creation/update operations, maintaining 1:1 correspondence with request items.",
        "properties": {
          "pipeline": {
            "type": "array",
            "description": "Array of individual success responses matching the request pipeline items.",
            "minItems": 1,
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "Individual success response for a pipeline operation, mirroring the request structure.",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Machine-readable success code.",
                  "enum": [
                    "SUCCESS"
                  ]
                },
                "details": {
                  "type": "object",
                  "description": "Operation-specific success details including resource identifiers.",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Unique identifier of the newly created pipeline configuration.",
                      "format": "int64"
                    }
                  },
                  "required": [
                    "id"
                  ],
                  "additionalProperties": false
                },
                "message": {
                  "type": "string",
                  "description": "Human-readable confirmation of the successful operation.",
                  "format": "string"
                },
                "status": {
                  "type": "string",
                  "description": "Overall status indicator.",
                  "enum": [
                    "success"
                  ]
                }
              },
              "required": [
                "code",
                "details",
                "message",
                "status"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "pipeline"
        ],
        "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.