Conga

Conga Price Dimensions API

The Price Dimensions API from Conga — 3 operation(s) for price dimensions.

GitHub OpenAPI
Business capability
Price List Management BC-440.20

Operations 8

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-dimensions Delete price dimensions in bulk · Delete price dimensions #
Ask an LLM
“Can I delete several price dimensions at once?”
“How do I bulk-remove price dimensions?”
Tell an agent destructive · confirm first
Bulk delete the selected price dimensions.
Remove many price dimensions in one call.
GET /price-dimensions List price dimensions · Retrieve price dimensions #
Ask an LLM
“Which price dimensions are defined?”
“Can I filter or page through price dimensions?”
Tell an agent
List all price dimensions.
List price dimensions matching {filter}.
PATCH /price-dimensions Update price dimensions in bulk · Update price dimensions #
Ask an LLM
“Can I edit multiple price dimensions in one request?”
“How do I bulk-update price dimensions?”
Tell an agent
Bulk update the selected price dimensions.
Edit several price dimensions at once.
POST /price-dimensions Create price dimensions · Create price dimensions #
Ask an LLM
“How do I create a new price dimension?”
“Can I add several price dimensions at once?”
Tell an agent
Create new price dimensions.
Add a batch of price dimensions.
DELETE /price-dimensions/{Id} Delete a price dimension · Delete a price dimension #
Ask an LLM
“Can I delete a single price dimension?”
“What happens when one price dimension is removed?”
Tell an agent destructive · confirm first
Delete price dimension {id}.
Remove only the price dimension {id}.
GET /price-dimensions/{Id} Get a price dimension · Retrieve a price dimension #
Ask an LLM
“Where can I see one price dimension?”
“Can I include related data when fetching a price dimension?”
Tell an agent
Get price dimension {id}.
Show price dimension {id} including {includes}.
PATCH /price-dimensions/{Id} Update a price dimension · Update a price dimension #
Ask an LLM
“How do I edit one price dimension?”
“Can I change a single dimension's source field?”
Tell an agent
Update price dimension {id}.
Edit only the price dimension {id}.
GET /price-dimensions/{name}/datasource-value Get a price dimension's data source value · Fetch Datasource value #
Ask an LLM
“What value does a price dimension resolve to for a record?”
“Can I fetch a dimension's datasource value for a business object?”
Tell an agent
Get the datasource value of dimension {name}.
Resolve dimension {name} for business object {obj}.

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-dimensions-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-dimensions-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-dimensions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Administration Price Dimensions API
  version: 1.0.0
servers:
- url: https://rls.congacloud.com/api/revenue-admin/v1
security:
- Bearer: []
tags:
- name: Price Dimensions
paths:
  /price-dimensions:
    delete:
      tags:
      - Price Dimensions
      summary: Delete price dimensions
      description: 'Deletes one or more price dimensions. It can delete a maximum of 100 price dimensions.


        When executed, this API returns one or more records with the delete status of each associated record ID.'
      requestBody:
        description: The list of price dimensions to delete
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceDimension'
            example:
            - Id: Id of the record to delete
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceDimension'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceDimension'
      responses:
        '200':
          description: OK
      operationId: deletePriceDimensions
      x-operation-id-source: derived
    get:
      tags:
      - Price Dimensions
      summary: Retrieve price dimensions
      description: 'Retrieves all price dimensions. Use query parameters to further narrow the results.


        When executed, this API returns all price dimensions.'
      parameters:
      - name: filter
        in: query
        description: Optional filter parameters
        schema:
          type: array
          items:
            type: string
      - name: sort
        in: query
        description: Optional sort parameter
        schema:
          type: string
      - name: page
        in: query
        description: Page number
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: Number of items per page
        schema:
          type: integer
          format: int32
          default: 50
      - name: includes
        in: query
        description: Optional related entities to include
        schema:
          type: array
          items:
            type: string
      - name: field
        in: query
        description: Pass Comma separated mulitple fields
        schema:
          type: array
          items:
            type: string
      - name: filterExpression
        in: query
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      operationId: getPriceDimensions
      x-operation-id-source: derived
    patch:
      tags:
      - Price Dimensions
      summary: Update price dimensions
      description: 'Updates updates specific fields on one or more price dimensions. It can update any fields except price dimension ID.


        When executed, this API returns the updated price dimension or price dimensions.'
      requestBody:
        description: The list of price dimensions with updated data
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
            example:
            - Name: PriceDimensionName
              IsActive: true
              AttributeGroup:
                Id: AttributeGroupId
                Name: AttributeGroup-Name
              BusinessObject: BusinessObject Name
              ContextType: Context Type
              Datasource: Data Source Name
              Description: Description
              Incentive:
                Id: Incentive-Id
                Name: IncentiveName
              IsPicklist: true
              Label: Label name
              RelationType: Relation Type
              Type: Type
              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: patchPriceDimensions
      x-operation-id-source: derived
    post:
      tags:
      - Price Dimensions
      summary: Create price dimensions
      description: 'Creates one or more price dimensions.


        When executed, this API returns a unique price dimension ID (string) that CPQ automatically generates.'
      requestBody:
        description: The list of price dimensions to create
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceDimension'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceDimension'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceDimension'
      responses:
        '200':
          description: OK
      operationId: postPriceDimensions
      x-operation-id-source: derived
  /price-dimensions/{Id}:
    delete:
      tags:
      - Price Dimensions
      summary: Delete a price dimension
      description: Deletes a price dimension based on the ID provided.
      parameters:
      - name: Id
        in: path
        description: The identifier of the price dimension to delete
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      operationId: deletePriceDimensionsById
      x-operation-id-source: derived
    get:
      tags:
      - Price Dimensions
      summary: Retrieve a price dimension
      description: Retrieves details of a price dimensions associated with the provided price dimensions ID.
      parameters:
      - name: Id
        in: path
        description: The identifier of the price dimension
        required: true
        schema:
          type: string
      - name: includes
        in: query
        description: Optional related entities to include
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PriceDimension'
            application/json:
              schema:
                $ref: '#/components/schemas/PriceDimension'
            text/json:
              schema:
                $ref: '#/components/schemas/PriceDimension'
        '204':
          description: No Content
      operationId: getPriceDimensionsById
      x-operation-id-source: derived
    patch:
      tags:
      - Price Dimensions
      summary: Update a price dimension
      description: Updates a price dimension based on the details provided in the request body.
      parameters:
      - name: Id
        in: path
        description: The identifier of the price dimension to update
        required: true
        schema:
          type: string
      requestBody:
        description: The updated data of the price dimension
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              Name: PriceDimensionName
              IsActive: true
              AttributeGroup:
                Id: AttributeGroupId
                Name: AttributeGroup-Name
              BusinessObject: BusinessObject Name
              ContextType: Context Type
              Datasource: Data Source Name
              Description: Description
              Incentive:
                Id: Incentive-Id
                Name: IncentiveName
              IsPicklist: true
              Label: Label name
              RelationType: Relation Type
              Type: Type
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '200':
          description: OK
      operationId: patchPriceDimensionsById
      x-operation-id-source: derived
  /price-dimensions/{name}/datasource-value:
    get:
      tags:
      - Price Dimensions
      summary: Fetch Datasource value
      parameters:
      - name: name
        in: path
        description: Incentive Program Name
        required: true
        schema:
          type: string
      - name: businessObjectId
        in: query
        description: BusinessObjectId
        schema:
          type: string
      responses:
        '200':
          description: OK
      operationId: getPriceDimensionsByNameDatasourceValue
      x-operation-id-source: derived
components:
  schemas:
    LookupObject:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
      additionalProperties: false
    PriceDimension:
      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'
        AttributeGroup:
          $ref: '#/components/schemas/LookupObject'
        BusinessObject:
          type:
          - string
          - 'null'
        ChildFilterName:
          type:
          - string
          - 'null'
        ContextType:
          type:
          - string
          - 'null'
        CumulativeDimension:
          $ref: '#/components/schemas/LookupObject'
        Datasource:
          type:
          - string
          - 'null'
        Description:
          type:
          - string
          - 'null'
        Incentive:
          $ref: '#/components/schemas/LookupObject'
        RelationType:
          type:
          - string
          - 'null'
        Type:
          type:
          - string
          - 'null'
      additionalProperties: {}
      example:
        Name: PriceDimensionName
        IsActive: true
        AttributeGroup:
          Id: AttributeGroupId
          Name: AttributeGroup-Name
        BusinessObject: BusinessObject Name
        ContextType: Context Type
        Datasource: Data Source Name
        Description: Description
        Incentive:
          Id: Incentive-Id
          Name: IncentiveName
        IsPicklist: true
        Label: Label name
        RelationType: Relation Type
        Type: Type
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header