---
title: "Update an opportunity stage"
method: PATCH
path: "/opportunity-stages/{id}"
tags: ["Opportunity Stages"]
---

# Update an opportunity stage

`PATCH /opportunity-stages/{id}`

## Request

- Base URL: `https://www.ruddr.io/api/workspace`
- URL: `https://www.ruddr.io/api/workspace/opportunity-stages/{id}`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string: The name of the opportunity stage. Max 255 characters.
  - `description` string, nullable: The description of the opportunity stage. Max 5000 characters.
  - `probability` number: The win probability for opportunities at this stage, expressed as a decimal between 0 and 1. Max 4 decimal places.
  - `statusId` 'open' | 'won' | 'lost': The status of the stage.
  - `isActive` boolean: Whether the opportunity stage is active.
  - `opportunityPipelineId` string: The ID (`uuid`) of the parent opportunity pipeline.

## Response `200`

200

- OpportunityStage
  - `id` string: The unique identifier for the object.
  - `name` string: The name of the opportunity stage.
  - `description` string, nullable: The description of the opportunity stage.
  - `probability` number: The win probability for opportunities at this stage, expressed as a decimal between 0 and 1.
  - `statusId` 'open' | 'won' | 'lost': The status of the stage.
  - `isActive` boolean: Whether the opportunity stage is active.
  - `opportunityPipelineId` string: The unique identifier for the parent opportunity pipeline.
  - `createdAt` string, date-time: The timestamp when the object was created.

## Other responses

- `400`: 400
- `403`: 403
- `404`: 404
- `409`: 409

---

[API](https://skmtc.dev/ruddr/apis/ruddr-api.md) · [All operations](https://skmtc.dev/ruddr/apis/ruddr-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ruddr/apis/ruddr-api/revisions/01c3f2a969ba?raw)