Create QBR opportunities

Batch-creates typed opportunities from current QBR trigger keys. Requires opportunity management: Community Edition answers 403 `ENTERPRISE_EDITION_REQUIRED`, and plans below Pro answer 403 `TIER_ACCESS_DENIED`.

RBAC · opportunities

Path parameters

clientIdstring <uuid>Required

Request body

Content type: application/json · schema OpportunityQbrCreateBodyV1

trigger_keysarray of stringRequired

min items 1 · max items 100

itemsstring

min length 1

Response body

Success response 201 · schema OpportunityApiSuccessV1

dataobjectRequired

metaobject

Response codes

201

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.

POST /api/v1/opportunities/qbr/{clientId}/opportunities

cURL

curl -X POST "https://algapsa.com/api/v1/opportunities/qbr/{clientId}/opportunities" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "trigger_keys": [
    "x"
  ]
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/opportunities/qbr/{clientId}/opportunities", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "trigger_keys": [
      "x"
    ]
  })
});
const data = await response.json();

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

201 OK·application/json

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