Conga

Conga Price Program Rules API

The Price Program Rules API from Conga — 2 operation(s) for price program rules.

GitHub OpenAPI
Business capability
Discount & Promotion Management BC-440.30

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

DELETE /price-programs/{ParentId}/rules Delete several incentive rules from a price program · Delete incentive rules #
Ask an LLM
“How can I bulk remove many rules from an incentive at once?”
“Can I clear out multiple price program rules in a single delete request?”
Tell an agent destructive · confirm first
Bulk delete several incentive rules from price program {ParentId}.
Remove a set of rules from incentive {ParentId} in one request.
GET /price-programs/{ParentId}/rules List the incentive rules of a price program · Retrieve incentive rules #
Ask an LLM
“How do I see all the incentive rules attached to one price program?”
“Can I page through and filter the rules defined for an incentive?”
Tell an agent
List every incentive rule in price program {ParentId}.
Show page {page} of the rules for incentive {ParentId}, {limit} per page.
PATCH /price-programs/{ParentId}/rules Update several incentive rules of a price program · Update incentive rules #
Ask an LLM
“Can I edit many incentive rules of a price program in one bulk update?”
“Is it possible to reassign incentive rules to another price program during a bulk update?”
Tell an agent
Bulk update several incentive rules in price program {ParentId}.
Apply changes to multiple rules of incentive {ParentId} at the same time.
POST /price-programs/{ParentId}/rules Add incentive rules to a price program · Create incentive rules #
Ask an LLM
“What's the way to add several new rules to an incentive in one call?”
“Does the parent incentive get set automatically when I create its rules?”
Tell an agent
Create a batch of new incentive rules under price program {ParentId}.
Add new rules to incentive {ParentId}.
DELETE /price-programs/{ParentId}/rules/{Id} Delete one incentive rule from a price program · Delete an incentive rule #
Ask an LLM
“How do I delete a single incentive rule from a price program?”
“Can I remove one specific rule from an incentive by its ID?”
Tell an agent destructive · confirm first
Delete incentive rule {Id} from price program {ParentId}.
Remove only rule {Id} from incentive {ParentId}.
GET /price-programs/{ParentId}/rules/{Id} Get one incentive rule of a price program · Retrieve an incentive rule #
Ask an LLM
“How do I look up a single incentive rule by its ID?”
“What is configured on one particular rule of my price program?”
Tell an agent
Get incentive rule {Id} from price program {ParentId}.
Show the details of rule {Id} in incentive {ParentId}.
PATCH /price-programs/{ParentId}/rules/{Id} Update one incentive rule of a price program · Update an incentive rule #
Ask an LLM
“What do I call to change the settings of one incentive rule?”
“Can I edit a single price program rule by its ID?”
Tell an agent
Update incentive rule {Id} in price program {ParentId}.
Edit just rule {Id} of incentive {ParentId}.

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/authentication/conga-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/rate-limits/conga-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-price-program-rules-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/data-model/conga-data-model.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/scopes/conga-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conventions/conga-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/errors/conga-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/lifecycle/conga-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conformance/conga-conformance.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/sandbox/conga-sandbox.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/asyncapi/conga-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/conga:conga-price-program-rules-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

conga-price-program-rules-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Incentive Administration Price Program Rules API
  version: 1.0.0
servers:
- url: https://rls.congacloud.com/api/incentive-admin/v1
security:
- Bearer: []
tags:
- name: Price Program Rules
paths:
  /price-programs/{ParentId}/rules:
    delete:
      tags:
      - Price Program Rules
      summary: Delete incentive rules
      description: Deletes one or more incentive rules from the collection.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent incentive
        required: true
        schema:
          type: string
      requestBody:
        description: The list of records to delete
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/IncentiveRule'
            example:
            - Id: Id of the record to delete
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/IncentiveRule'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/IncentiveRule'
      responses:
        '200':
          description: OK
      operationId: deletePriceProgramsByParentIdRules
      x-operation-id-source: derived
    get:
      tags:
      - Price Program Rules
      summary: Retrieve incentive rules
      description: Retrieves a collection of incentive rules based on the parent incentive.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent incentive
        required: true
        schema:
          type: string
      - name: filter
        in: query
        description: An optional array of filters
        schema:
          type: array
          items:
            type: string
      - name: sort
        in: query
        description: An optional sort criteria
        schema:
          type: string
      - name: page
        in: query
        description: The page number for pagination
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: The maximum number of records per page
        schema:
          type: integer
          format: int32
          default: 50
      - name: includes
        in: query
        description: An optional array of included fields
        schema:
          type: array
          items:
            type: string
      - name: field
        in: query
        description: Pass Comma separated multiple fields
        schema:
          type: array
          items:
            type: string
      - name: filterExpression
        in: query
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      operationId: getPriceProgramsByParentIdRules
      x-operation-id-source: derived
    patch:
      tags:
      - Price Program Rules
      summary: Update incentive rules
      description: Updates one or more incentive rules in the collection. Parent reassignment is not allowed.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent incentive
        required: true
        schema:
          type: string
      requestBody:
        description: The list of records to be updated
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
            example:
            - Name: PriceProgramRuleName
              AdjustmentAppliesTo: Base Price
              AdjustmentChargeType: Adjustment
              BenefitType: Price Only
              Criteria: null
              Description: Price program rule Description
              Dimension1:
                Id: Dimension1Id
                Name: DimensionName1
              Dimension1ValueType: value
              Dimension2: null
              Dimension2ValueType: null
              Dimension3: null
              Dimension3ValueType: null
              Dimension4: null
              Dimension4ValueType: null
              Dimension5: null
              Dimension5ValueType: null
              Dimension6: null
              Dimension6ValueType: null
              EffectiveDate: '2024-09-08'
              ExpirationDate: '2029-09-08'
              ForEveryXCriteriaDimension: null
              ForEveryXCriteriaDimensionType: null
              ForEveryXCriteriaDimensionValue: null
              FutureBenefitValidityOffset: null
              FutureBenefitValidityType: null
              IsActive: true
              ProductCriteria: null
              ProductCriteriaOper: null
              ProductFamilyCriteria: null
              ProductFamilyCriteriaOper: null
              ProductGroupCriteria: null
              ProductGroupCriteriaOper: null
              RegionCriteria: null
              RegionCriteriaOper: null
              RateType: Single Rate
              RateTableTierType: null
              TierMetricType: null
              TierMetricRollupDuration: No Rollup
              MetricValueSource: null
              Id: Id of the record
          text/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
          application/*+json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
      responses:
        '200':
          description: OK
      operationId: patchPriceProgramsByParentIdRules
      x-operation-id-source: derived
    post:
      tags:
      - Price Program Rules
      summary: Create incentive rules
      description: Adds one or more incentive rules to the collection. The parent incentive is automatically filled.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent incentive
        required: true
        schema:
          type: string
      requestBody:
        description: The list of incentive rules to add to the collection
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/IncentiveRule'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/IncentiveRule'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/IncentiveRule'
      responses:
        '200':
          description: OK
      operationId: postPriceProgramsByParentIdRules
      x-operation-id-source: derived
  /price-programs/{ParentId}/rules/{Id}:
    delete:
      tags:
      - Price Program Rules
      summary: Delete an incentive rule
      description: Deletes a single incentive rule document based on the identifier and parent incentive.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent incentive
        required: true
        schema:
          type: string
      - name: Id
        in: path
        description: The identifier of the incentive rule
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      operationId: deletePriceProgramsByParentIdRulesById
      x-operation-id-source: derived
    get:
      tags:
      - Price Program Rules
      summary: Retrieve an incentive rule
      description: Retrieves a single incentive rule document based on the identifier and parent incentive.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent incentive
        required: true
        schema:
          type: string
      - name: Id
        in: path
        description: The identifier of the incentive rule
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      operationId: getPriceProgramsByParentIdRulesById
      x-operation-id-source: derived
    patch:
      tags:
      - Price Program Rules
      summary: Update an incentive rule
      description: Updates a single incentive rule document based on the identifier and parent incentive.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent incentive
        required: true
        schema:
          type: string
      - name: Id
        in: path
        description: The identifier of the incentive rule
        required: true
        schema:
          type: string
      requestBody:
        description: The updated state of the incentive rule
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              Name: PriceProgramRuleName
              AdjustmentAppliesTo: Base Price
              AdjustmentChargeType: Adjustment
              BenefitType: Price Only
              Criteria: null
              Description: Price program rule Description
              Dimension1:
                Id: Dimension1Id
                Name: DimensionName1
              Dimension1ValueType: value
              Dimension2: null
              Dimension2ValueType: null
              Dimension3: null
              Dimension3ValueType: null
              Dimension4: null
              Dimension4ValueType: null
              Dimension5: null
              Dimension5ValueType: null
              Dimension6: null
              Dimension6ValueType: null
              EffectiveDate: '2024-09-08'
              ExpirationDate: '2029-09-08'
              ForEveryXCriteriaDimension: null
              ForEveryXCriteriaDimensionType: null
              ForEveryXCriteriaDimensionValue: null
              FutureBenefitValidityOffset: null
              FutureBenefitValidityType: null
              IsActive: true
              ProductCriteria: null
              ProductCriteriaOper: null
              ProductFamilyCriteria: null
              ProductFamilyCriteriaOper: null
              ProductGroupCriteria: null
              ProductGroupCriteriaOper: null
              RegionCriteria: null
              RegionCriteriaOper: null
              RateType: Single Rate
              RateTableTierType: null
              TierMetricType: null
              TierMetricRollupDuration: No Rollup
              MetricValueSource: null
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '200':
          description: OK
      operationId: patchPriceProgramsByParentIdRulesById
      x-operation-id-source: derived
components:
  schemas:
    LookupObject:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
      additionalProperties: false
    IncentiveRule:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
        CreatedBy:
          $ref: '#/components/schemas/LookupObject'
        CreatedDate:
          type: string
          format: date-time
        ModifiedBy:
          $ref: '#/components/schemas/LookupObject'
        ModifiedDate:
          type: string
          format: date-time
        ExternalId:
          type:
          - string
          - 'null'
        ETag:
          type:
          - string
          - 'null'
        AdjustmentAppliesTo:
          type:
          - string
          - 'null'
        AdjustmentChargeType:
          type:
          - string
          - 'null'
        BenefitType:
          type:
          - string
          - 'null'
        Criteria:
          type:
          - string
          - 'null'
        Description:
          type:
          - string
          - 'null'
        Dimension1:
          $ref: '#/components/schemas/LookupObject'
        Dimension1ValueType:
          type:
          - string
          - 'null'
        Dimension2:
          $ref: '#/components/schemas/LookupObject'
        Dimension2ValueType:
          type:
          - string
          - 'null'
        Dimension3:
          $ref: '#/components/schemas/LookupObject'
        Dimension3ValueType:
          type:
          - string
          - 'null'
        Dimension4:
          $ref: '#/components/schemas/LookupObject'
        Dimension4ValueType:
          type:
          - string
          - 'null'
        Dimension5:
          $ref: '#/components/schemas/LookupObject'
        Dimension5ValueType:
          type:
          - string
          - 'null'
        Dimension6:
          $ref: '#/components/schemas/LookupObject'
        Dimension6ValueType:
          type:
          - string
          - 'null'
        EffectiveDate:
          type:
          - string
          - 'null'
          format: date-time
        ExpirationDate:
          type:
          - string
          - 'null'
          format: date-time
        ForEveryXCriteriaDimension:
          $ref: '#/components/schemas/LookupObject'
        ForEveryXCriteriaDimensionType:
          type:
          - string
          - 'null'
        ForEveryXCriteriaDimensionValue:
          type:
          - number
          - 'null'
          format: double
        FutureBenefitValidityOffset:
          type:
          - number
          - 'null'
          format: double
        FutureBenefitValidityType:
          type:
          - string
          - 'null'
        IsActive:
          type:
          - boolean
          - 'null'
        MetricValueSourceAggregator:
          type:
          - string
          - 'null'
        ProductCriteria:
          type:
          - array
          - 'null'
          items:
            type: string
        ProductCriteriaOper:
          type:
          - string
          - 'null'
        ProductFamilyCriteria:
          type:
          - array
          - 'null'
          items:
            type: string
        ProductFamilyCriteriaOper:
          type:
          - array
          - 'null'
          items:
            type: string
        ProductGroupCriteria:
          type:
          - array
          - 'null'
          items:
            type: string
        ProductGroupCriteriaOper:
          type:
          - string
          - 'null'
        RegionCriteria:
          type:
          - array
          - 'null'
          items:
            type: string
        RegionCriteriaOper:
          type:
          - string
          - 'null'
        RateType:
          type:
          - string
          - 'null'
        RateTableTierType:
          type:
          - string
          - 'null'
        TierMetricType:
          type:
          - string
          - 'null'
        TierMetricRollupDuration:
          type:
          - string
          - 'null'
        MetricValueSource:
          type:
          - string
          - 'null'
        Incentive:
          $ref: '#/components/schemas/LookupObject'
      additionalProperties: {}
      example:
        Name: PriceProgramRuleName
        AdjustmentAppliesTo: Base Price
        AdjustmentChargeType: Adjustment
        BenefitType: Price Only
        Criteria: null
        Description: Price program rule Description
        Dimension1:
          Id: Dimension1Id
          Name: DimensionName1
        Dimension1ValueType: value
        Dimension2: null
        Dimension2ValueType: null
        Dimension3: null
        Dimension3ValueType: null
        Dimension4: null
        Dimension4ValueType: null
        Dimension5: null
        Dimension5ValueType: null
        Dimension6: null
        Dimension6ValueType: null
        EffectiveDate: '2024-09-08'
        ExpirationDate: '2029-09-08'
        ForEveryXCriteriaDimension: null
        ForEveryXCriteriaDimensionType: null
        ForEveryXCriteriaDimensionValue: null
        FutureBenefitValidityOffset: null
        FutureBenefitValidityType: null
        IsActive: true
        ProductCriteria: null
        ProductCriteriaOper: null
        ProductFamilyCriteria: null
        ProductFamilyCriteriaOper: null
        ProductGroupCriteria: null
        ProductGroupCriteriaOper: null
        RegionCriteria: null
        RegionCriteriaOper: null
        RateType: Single Rate
        RateTableTierType: null
        TierMetricType: null
        TierMetricRollupDuration: No Rollup
        MetricValueSource: null
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header