Set opportunity stage

Sets an open-pipeline stage through the declared-evidence flow the board drag uses; won and lost answer 400 pointing at /win and /lose.

RBAC · opportunities

Path parameters

idstring <uuid>Required

Opportunity UUID from opportunities.opportunity_id.

Request body

Content type: application/json · schema SetOpportunityStageBodyV1

stagestringRequired

Enum: identifiedqualifiedassessmentproposedverbalwonlost

detailstringNullable

Response body

Success response 200 · schema OpportunityApiSuccessV1

dataobjectRequired

metaobject

Response codes

200

Operation succeeded.

400

Validation or request parsing failure.

401

API key missing or invalid.

403

RBAC denied for the opportunities resource action.

404

Opportunity or nested resource not found.

409

Opportunity state conflicts with the requested operation.

500

Unexpected controller or service failure.

POST /api/v1/opportunities/{id}/stage

cURL

curl -X POST "https://algapsa.com/api/v1/opportunities/{id}/stage" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "stage": "identified",
  "detail": "string"
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/opportunities/{id}/stage", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "stage": "identified",
    "detail": "string"
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/opportunities/{id}/stage");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""stage"": ""identified"",
  ""detail"": ""string""
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {},
  "meta": {}
}