Skip to main content
POST
/
opportunity-stages
Create an opportunity stage
curl --request POST \
  --url https://www.ruddr.io/api/workspace/opportunity-stages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "probability": 123,
  "statusId": "<string>",
  "description": "<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.

Body

application/json
name
string
required

The name of the opportunity stage.

probability
number
required

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

statusId
string
required

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

description
string

The description of the opportunity stage.

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.