Update commitment

Edits or resolves a commitment to a downstream artifact or explicit decline. Requires opportunity management: Community Edition answers 403 `ENTERPRISE_EDITION_REQUIRED`, and plans below Pro answer 403 `TIER_ACCESS_DENIED`.

RBAC · opportunities

Path parameters

idstring <uuid>Required

commitmentIdstring <uuid>Required

Request body

Content type: application/json · schema OpportunityCommitmentUpdateBodyV1

descriptionstring

min length 1 · max length 4000

resolution_statusstring

Enum: openquote_lineagreement_lineproject_taskdeclined

resolution_ref_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, or the caller’s edition and plan do not include opportunity management (`ENTERPRISE_EDITION_REQUIRED` in Community Edition; `TIER_ACCESS_DENIED` below the Pro plan).

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}/commitments/{commitmentId}

cURL

curl -X PUT "https://algapsa.com/api/v1/opportunities/{id}/commitments/{commitmentId}" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "x",
  "resolution_status": "open",
  "resolution_ref_id": "01HN2K7VRB9PQ3Y0000000000"
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/opportunities/{id}/commitments/{commitmentId}", {
  method: "PUT",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "description": "x",
    "resolution_status": "open",
    "resolution_ref_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}/commitments/{commitmentId}");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""description"": ""x"",
  ""resolution_status"": ""open"",
  ""resolution_ref_id"": ""01HN2K7VRB9PQ3Y0000000000""
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

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