PUT/api/v1/opportunities/{id}

Product availabilityAlgaPSA

Update opportunity

Updates editable opportunity fields; status and stage use dedicated flows.

RBAC · opportunities

Path parameters

idstring <uuid>Required

Opportunity UUID from opportunities.opportunity_id.

Request body

Content type: application/json · schema UpdateOpportunityBodyV1

client_idstring <uuid>

contact_idstring <uuid>Nullable

titlestring

min length 1

opportunity_typestring

Enum: new_logoexpansionrenewalproject

owner_idstring <uuid>

confidencestring

default "medium"

Enum: lowmediumhighcommitted

mrr_centsinteger

default 0 · ≥ 0

nrr_centsinteger

default 0 · ≥ 0

hardware_centsinteger

default 0 · ≥ 0

currency_codestring

min length 3 · max length 3

expected_close_datestringNullable

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

next_actionstring

min length 1

next_action_duestring <date-time>

generator_keystringNullable

Enum: renewaltm_conversionwhitespaceasset_aginginbound-lead

generator_contextobjectNullable

suggestion_idstring <uuid>Nullable

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.

PUT /api/v1/opportunities/{id}

cURL

curl -X PUT "https://algapsa.com/api/v1/opportunities/{id}" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "client_id": "01HN2K7VRB9PQ3Y0000000000",
  "contact_id": "01HN2K7VRB9PQ3Y0000000000",
  "title": "x",
  "opportunity_type": "new_logo",
  "owner_id": "01HN2K7VRB9PQ3Y0000000000",
  "confidence": "medium",
  "mrr_cents": 0,
  "nrr_cents": 0,
  "hardware_cents": 0,
  "currency_code": "xxx",
  "expected_close_date": "",
  "next_action": "x",
  "next_action_due": "2026-04-18T15:22:14Z",
  "generator_key": "renewal",
  "generator_context": {},
  "suggestion_id": "01HN2K7VRB9PQ3Y0000000000"
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/opportunities/{id}", {
  method: "PUT",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "client_id": "01HN2K7VRB9PQ3Y0000000000",
    "contact_id": "01HN2K7VRB9PQ3Y0000000000",
    "title": "x",
    "opportunity_type": "new_logo",
    "owner_id": "01HN2K7VRB9PQ3Y0000000000",
    "confidence": "medium",
    "mrr_cents": 0,
    "nrr_cents": 0,
    "hardware_cents": 0,
    "currency_code": "xxx",
    "expected_close_date": "",
    "next_action": "x",
    "next_action_due": "2026-04-18T15:22:14Z",
    "generator_key": "renewal",
    "generator_context": {},
    "suggestion_id": "01HN2K7VRB9PQ3Y0000000000"
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "https://algapsa.com/api/v1/opportunities/{id}");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""client_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""contact_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""title"": ""x"",
  ""opportunity_type"": ""new_logo"",
  ""owner_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""confidence"": ""medium"",
  ""mrr_cents"": 0,
  ""nrr_cents"": 0,
  ""hardware_cents"": 0,
  ""currency_code"": ""xxx"",
  ""expected_close_date"": """",
  ""next_action"": ""x"",
  ""next_action_due"": ""2026-04-18T15:22:14Z"",
  ""generator_key"": ""renewal"",
  ""generator_context"": {},
  ""suggestion_id"": ""01HN2K7VRB9PQ3Y0000000000""
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

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