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": "open",
  "opportunityPipelineId": "<string>",
  "description": "<string>",
  "isActive": true
}
'
{
  "id": "d4a8c1e7-5f32-4b69-80d3-a9e2f6c01b85",
  "name": "Proposal Sent",
  "description": "A formal proposal has been submitted to the prospective client for review.",
  "probability": 0.45,
  "statusId": "open",
  "isActive": true,
  "opportunityPipelineId": "b9c85ac3-1a1d-4f31-a0c5-6e7d3d8ee0b2",
  "createdAt": "2025-04-18T10:22:37.614Z"
}
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. Max 255 characters.

​
probability
number
required

The win probability for opportunities at this stage, expressed as a decimal between 0 and 1. Max 4 decimal places.

​
statusId
enum<string>
required

The status of the stage.

Available options:
open,
won,
lost
​
opportunityPipelineId
string
required

The ID (uuid) of the parent opportunity pipeline.

​
description
string | null

The description of the opportunity stage. Max 5000 characters.

​
isActive
boolean

Whether the opportunity stage is active. Defaults to true if not provided.

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 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.