Skip to main content
PATCH
/
opportunity-stages
/
{id}
Update an opportunity stage
curl --request PATCH \
  --url https://www.ruddr.io/api/workspace/opportunity-stages/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "probability": 123,
  "statusId": "<string>",
  "isActive": true
}
'
{
  "id": "7e3f1b2c-94d5-4a8e-b612-f09c3d7e5a21",
  "name": "Qualified Lead",
  "description": "The lead has shown interest and meets basic qualifying criteria for the service offering.",
  "probability": 0.2,
  "statusId": "open",
  "isActive": true,
  "createdAt": "2025-03-10T14:22:45.183Z"
}
A stage in the sales process used to track the progress of an opportunity.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The opportunity stage uuid

Body

application/json
​
name
string

The name of the opportunity stage.

​
description
string

The description of the opportunity stage.

​
probability
number

The likelihood percentage that an opportunity at this stage will close successfully.

​
statusId
string

The status of the stage. Can be one of open, won, or lost.

​
isActive
boolean

Whether the opportunity stage is active.

Response

200

​
id
string

The unique identifier for the object.

​
name
string

The name of the opportunity stage.

​
description
string | null

The description of the opportunity stage.

​
probability
number

The likelihood percentage that an opportunity at this stage will close successfully.

​
statusId
string

The status of the stage. Can be one of open, won, or lost.

​
isActive
boolean

Whether the opportunity stage is active.

​
createdAt
string<date-time>

The timestamp when the object was created.