Complete opportunity step

Completes a current step and promotes an existing planned successor or creates a replacement action.

RBAC · opportunities

Path parameters

idstring <uuid>Required

Opportunity UUID from opportunities.opportunity_id.

stepIdstring <uuid>Required

Step UUID from opportunity_steps.step_id.

Request body

Content type: application/json · schema CompleteOpportunityStepBodyV1

next_step_idstring <uuid>Nullable

next_actionstringNullable

min length 1 · max length 300

next_action_duestring <date-time>Nullable

checkpointstringNullable

Enum: qualifiedassessmentproposedverbalwon

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}/steps/{stepId}/complete

cURL

curl -X POST "https://algapsa.com/api/v1/opportunities/{id}/steps/{stepId}/complete" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "next_step_id": "01HN2K7VRB9PQ3Y0000000000",
  "next_action": "x",
  "next_action_due": "2026-04-18T15:22:14Z",
  "checkpoint": "qualified"
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/opportunities/{id}/steps/{stepId}/complete", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "next_step_id": "01HN2K7VRB9PQ3Y0000000000",
    "next_action": "x",
    "next_action_due": "2026-04-18T15:22:14Z",
    "checkpoint": "qualified"
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/opportunities/{id}/steps/{stepId}/complete");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""next_step_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""next_action"": ""x"",
  ""next_action_due"": ""2026-04-18T15:22:14Z"",
  ""checkpoint"": ""qualified""
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

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