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

idstring required

The opportunity stage uuid.

Request body

namestring

The name of the opportunity stage. Max 255 characters.

descriptionstring nullable

The description of the opportunity stage. Max 5000 characters.

probabilitynumber

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.

isActiveboolean

Whether the opportunity stage is active.

opportunityPipelineIdstring

The ID (uuid) of the parent opportunity pipeline.

Response

200

idstring

The unique identifier for the object.

namestring

The name of the opportunity stage.

descriptionstring nullable

The description of the opportunity stage.

probabilitynumber

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.

isActiveboolean

Whether the opportunity stage is active.

opportunityPipelineIdstring

The unique identifier for the parent opportunity pipeline.

createdAtstring date-time

The timestamp when the object was created.

Example response

{
  "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,
  "opportunityPipelineId": "b9c85ac3-1a1d-4f31-a0c5-6e7d3d8ee0b2",
  "createdAt": "2025-03-10T14:22:45.183Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.