Win opportunity

Marks an open opportunity won, optionally converting an accepted linked quote to a draft agreement.

RBAC · opportunities

Path parameters

idstring <uuid>Required

Opportunity UUID from opportunities.opportunity_id.

Request body

Content type: application/json · schema WinOpportunityBodyV1

convert_quote_idstring <uuid>

project_template_idstring <uuid>

project_namestring

min length 1

project_status_idstring <uuid>

project_start_datestring

pattern /^\d{4}-\d{2}-\d{2}$/

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}/win

cURL

curl -X POST "https://algapsa.com/api/v1/opportunities/{id}/win" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "convert_quote_id": "01HN2K7VRB9PQ3Y0000000000",
  "project_template_id": "01HN2K7VRB9PQ3Y0000000000",
  "project_name": "x",
  "project_status_id": "01HN2K7VRB9PQ3Y0000000000",
  "project_start_date": ""
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/opportunities/{id}/win", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "convert_quote_id": "01HN2K7VRB9PQ3Y0000000000",
    "project_template_id": "01HN2K7VRB9PQ3Y0000000000",
    "project_name": "x",
    "project_status_id": "01HN2K7VRB9PQ3Y0000000000",
    "project_start_date": ""
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/opportunities/{id}/win");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""convert_quote_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""project_template_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""project_name"": ""x"",
  ""project_status_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""project_start_date"": """"
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

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