Conga

Conga Product Option Components API

The Product Option Components API from Conga — 2 operation(s) for product option components.

GitHub OpenAPI
Business capability
Product Configuration & Variant Management BC-820.40

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 /product-option-group/{ParentId}/products Remove option components from a bundle in bulk · Delete product option components #
Ask an LLM
“Is there a way to remove several products or options from a bundle at once?”
“Can I bulk delete options from an option group on a bundle?”
Tell an agent destructive · confirm first
Remove these option components from {ParentId} in bulk.
Delete several products and options from bundle {ParentId}.
GET /product-option-group/{ParentId}/products List a bundle's option components · Retrieve product option components #
Ask an LLM
“How do I see every option group and option in a bundle product?”
“Which options are configured under a Conga CPQ bundle?”
Tell an agent
List the option components for bundle {ParentId}.
Show option components of bundle {ParentId} matching {filter}.
PATCH /product-option-group/{ParentId}/products Update option components in bulk · Update product option components #
Ask an LLM
“How do I edit many option components in one request?”
“Can I bulk update the options under a bundle's option group?”
Tell an agent
Update several option components under {ParentId}.
Bulk edit the option components of {ParentId} with these changes.
POST /product-option-group/{ParentId}/products Add products and options to a bundle · Create product option components #
Ask an LLM
“How do I add standalone products or sub-bundles to a bundle?”
“Can I add options to an option group already on a bundle?”
Tell an agent
Add these products and options to bundle {ParentId}.
Create new option components under {ParentId}.
DELETE /product-option-group/{ParentId}/products/{Id} Delete a single option component · Delete product option component #
Ask an LLM
“How do I delete just one option component?”
“Can I remove one specific option from an option group by ID?”
Tell an agent destructive · confirm first
Delete option component {Id} from option group {ParentId}.
Remove the single option component {Id} under {ParentId}.
GET /product-option-group/{ParentId}/products/{Id} Get a single option component · Retrieve product option component #
Ask an LLM
“How do I look up one option component by its ID?”
“What settings does a single option component have?”
Tell an agent
Get option component {Id} in option group {ParentId}.
Show the details of option component {Id} under {ParentId}.
PATCH /product-option-group/{ParentId}/products/{Id} Update a single option component · Update a product option component #
Ask an LLM
“What's the call to change one option component's settings?”
“Can I edit a single option in an option group by its ID?”
Tell an agent
Update option component {Id} in option group {ParentId}.
Edit the single option component {Id} under {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-product-option-components-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-product-option-components-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-product-option-components-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Administration Product Option Components API
  version: 1.0.0
servers:
- url: https://rls.congacloud.com/api/revenue-admin/v1
security:
- Bearer: []
tags:
- name: Product Option Components
paths:
  /product-option-group/{ParentId}/products:
    delete:
      tags:
      - Product Option Components
      summary: Delete product option components
      description: Deletes products from a bundle or removes options from an option group associated with the bundle.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent product option group
        required: true
        schema:
          type: string
      requestBody:
        description: The list of records to delete
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ProductOptionComponent'
            example:
            - Id: Id of the record to delete
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ProductOptionComponent'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ProductOptionComponent'
      responses:
        '200':
          description: OK
      operationId: deleteProductOptionGroupByParentIdProducts
      x-operation-id-source: derived
    get:
      tags:
      - Product Option Components
      summary: Retrieve product option components
      description: Retrieves a list of all option groups and options associated with the bundle product ID provided in parameters. The options associated with the sub-bundle of the given product are not retrieved.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent product option group
        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 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: getProductOptionGroupByParentIdProducts
      x-operation-id-source: derived
    patch:
      tags:
      - Product Option Components
      summary: Update product option components
      description: Updates one or more product option components.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent product option group
        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: Name of the product
              AllowCloning: true
              AutoUpdateQuantity: true
              MaxQuantity: 10
              MinQuantity: 1
              IsModifiable: true
              ParentProduct:
                Id: ParentProduct-Id
                Name: ParentProduct-Name
              ComponentProduct:
                Id: ComponentProduct-Id
                Name: ComponentProduct-Name
              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: patchProductOptionGroupByParentIdProducts
      x-operation-id-source: derived
    post:
      tags:
      - Product Option Components
      summary: Create product option components
      description: Creates one or more standalone products and bundles to a bundle. Also adds options to an option group that is already associated with the bundle.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent product option group
        required: true
        schema:
          type: string
      requestBody:
        description: The list of product option components to add to the collection
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ProductOptionComponent'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ProductOptionComponent'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ProductOptionComponent'
      responses:
        '200':
          description: OK
      operationId: postProductOptionGroupByParentIdProducts
      x-operation-id-source: derived
  /product-option-group/{ParentId}/products/{Id}:
    delete:
      tags:
      - Product Option Components
      summary: Delete product option component
      description: Deletes a single product option component document based on the identifier and parent product option group.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent product option group
        required: true
        schema:
          type: string
      - name: Id
        in: path
        description: The identifier of the product option component
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      operationId: deleteProductOptionGroupByParentIdProductsById
      x-operation-id-source: derived
    get:
      tags:
      - Product Option Components
      summary: Retrieve product option component
      description: Retrieves a single product option component document based on the identifier and parent product option group.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent product option group
        required: true
        schema:
          type: string
      - name: Id
        in: path
        description: The identifier of the product option component
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      operationId: getProductOptionGroupByParentIdProductsById
      x-operation-id-source: derived
    patch:
      tags:
      - Product Option Components
      summary: Update a product option component
      description: Updates a single product option component document based on the identifier and parent product option group.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent product option group
        required: true
        schema:
          type: string
      - name: Id
        in: path
        description: The identifier of the product option component
        required: true
        schema:
          type: string
      requestBody:
        description: The updated state of the product option component
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              Name: Name of the product
              AllowCloning: true
              AutoUpdateQuantity: true
              MaxQuantity: 10
              MinQuantity: 1
              IsModifiable: true
              ParentProduct:
                Id: ParentProduct-Id
                Name: ParentProduct-Name
              ComponentProduct:
                Id: ComponentProduct-Id
                Name: ComponentProduct-Name
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '200':
          description: OK
      operationId: patchProductOptionGroupByParentIdProductsById
      x-operation-id-source: derived
components:
  schemas:
    LookupObject:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
      additionalProperties: false
    ProductOptionComponent:
      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'
        AllowCloning:
          type:
          - boolean
          - 'null'
        AutoUpdateQuantity:
          type:
          - boolean
          - 'null'
        ComponentProduct:
          $ref: '#/components/schemas/LookupObject'
        ConfigType:
          type:
          - string
          - 'null'
        IsDefault:
          type:
          - boolean
          - 'null'
        DefaultQuantity:
          type:
          - number
          - 'null'
          format: double
        DefaultQuantityExpression:
          type:
          - string
          - 'null'
        InclusionCriteria:
          type:
          - string
          - 'null'
        MaxQuantity:
          type:
          - number
          - 'null'
          format: double
        MaxQuantityExpression:
          type:
          - string
          - 'null'
        MinQuantity:
          type:
          - number
          - 'null'
          format: double
        MinQuantityExpression:
          type:
          - string
          - 'null'
        IsModifiable:
          type:
          - boolean
          - 'null'
        ParentProduct:
          $ref: '#/components/schemas/LookupObject'
        ProductOptionGroup:
          $ref: '#/components/schemas/LookupObject'
        RelationshipType:
          type:
          - string
          - 'null'
        IsRequired:
          type:
          - boolean
          - 'null'
        Sequence:
          type:
          - number
          - 'null'
          format: double
        UniqueKey:
          type:
          - string
          - 'null'
      additionalProperties: {}
      example:
        Name: Name of the product
        AllowCloning: true
        AutoUpdateQuantity: true
        MaxQuantity: 10
        MinQuantity: 1
        IsModifiable: true
        ParentProduct:
          Id: ParentProduct-Id
          Name: ParentProduct-Name
        ComponentProduct:
          Id: ComponentProduct-Id
          Name: ComponentProduct-Name
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header