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, "isActive": true, "opportunityPipelineId": "<string>" } '

{ "id": "a5f1c8d3-7e42-4b86-90d0-e3b7c6f02a19", "name": "Negotiation", "description": "Terms are being discussed and the deal is moving toward a close.", "probability": 0.75, "statusId": "open", "isActive": true, "opportunityPipelineId": "b9c85ac3-1a1d-4f31-a0c5-6e7d3d8ee0b2", "createdAt": "2025-02-10T09:15:42.891Z" }

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

The opportunity stage uuid.

Body

application/json

name

string

The name of the opportunity stage. Max 255 characters.

description

string | null

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

enum<string>

The status of the stage.

Available options:

open,

won,

lost

isActive

boolean

Whether the opportunity stage is active.

opportunityPipelineId

string

The ID (uuid) of the parent opportunity pipeline.

Response

200

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 win probability for opportunities at this stage, expressed as a decimal between 0 and 1.

statusId

enum<string>

The status of the stage.

Available options:

open,

won,

lost

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.