Conga

Conga Incentive Coupons API

The Incentive Coupons API from Conga — 3 operation(s) for incentive coupons.

GitHub OpenAPI
Business capability
Discount & Promotion Management BC-440.30

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 /incentives/{ParentId}/coupons Delete incentive coupons in bulk · Delete incentive coupons #
Ask an LLM
“Can I remove many coupons from an incentive?”
“How do I bulk-delete coupon codes?”
Tell an agent destructive · confirm first
Bulk delete coupons on incentive {incentive}.
Remove the selected coupons from incentive {incentive}.
GET /incentives/{ParentId}/coupons List an incentive's coupons · Retrieve incentive coupons #
Ask an LLM
“Which coupon codes exist for an incentive?”
“Can I filter an incentive's coupons?”
Tell an agent
List coupons of incentive {incentive}.
Show coupons on incentive {incentive} matching {filter}.
PATCH /incentives/{ParentId}/coupons Update incentive coupons in bulk · Update incentive coupons #
Ask an LLM
“Can I edit several coupons in one request?”
“How do I bulk-update coupon codes on an incentive?”
Tell an agent
Bulk update coupons on incentive {incentive}.
Edit the selected coupons of incentive {incentive}.
POST /incentives/{ParentId}/coupons Create incentive coupons · Create incentive coupons #
Ask an LLM
“How do I add specific coupon codes to an incentive?”
“Can I create several coupons by hand at once?”
Tell an agent
Create coupons on incentive {incentive}.
Add these coupon codes to incentive {incentive}.
POST /incentives/{ParentId}/coupons/generate/{numberOfCoupons} Auto-generate incentive coupons · Auto generates specified number of incentive coupons #
Ask an LLM
“Can the system generate a batch of coupon codes for me?”
“How many coupons can I auto-generate for an incentive?”
Tell an agent
Generate {count} coupons for incentive {incentive}.
Auto-create {count} coupon codes on {incentive}.
DELETE /incentives/{ParentId}/coupons/{Id} Delete an incentive coupon · Delete an incentive coupon #
Ask an LLM
“Can I delete a single coupon code?”
“How do I remove one coupon from an incentive?”
Tell an agent destructive · confirm first
Delete coupon {id} from incentive {incentive}.
Remove only coupon {id} on {incentive}.
GET /incentives/{ParentId}/coupons/{Id} Get an incentive coupon · Retrieve an incentive coupon #
Ask an LLM
“Where can I see one coupon's details?”
“What does a single coupon record show?”
Tell an agent
Get coupon {id} of incentive {incentive}.
Show coupon record {id} on {incentive}.
PATCH /incentives/{ParentId}/coupons/{Id} Update an incentive coupon · Update an incentive coupon #
Ask an LLM
“How do I edit one coupon?”
“Can I change a single coupon code record?”
Tell an agent
Update coupon {id} of incentive {incentive}.
Edit only coupon {id} on {incentive}.

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-incentive-coupons-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-incentive-coupons-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-incentive-coupons-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Administration Incentive Coupons API
  version: 1.0.0
servers:
- url: https://rls.congacloud.com/api/revenue-admin/v1
security:
- Bearer: []
tags:
- name: Incentive Coupons
paths:
  /incentives/{ParentId}/coupons:
    delete:
      tags:
      - Incentive Coupons
      summary: Delete incentive coupons
      description: Deletes one or more incentive coupons 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 incentive coupons to delete
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/IncentiveCoupon'
            example:
            - Id: Id of the record to delete
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/IncentiveCoupon'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/IncentiveCoupon'
      responses:
        '200':
          description: OK
      operationId: deleteIncentivesByParentIdCoupons
      x-operation-id-source: derived
    get:
      tags:
      - Incentive Coupons
      summary: Retrieve incentive coupons
      description: Retrieves a collection of incentive coupons 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 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: getIncentivesByParentIdCoupons
      x-operation-id-source: derived
    patch:
      tags:
      - Incentive Coupons
      summary: Update incentive coupons
      description: Updates one or more incentive coupons 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: IncentiveCouponName
              IsActive: true
              PriceDimension:
                Id: PriceDimensionId
                Name: PriceDimensionName
              AssignedToID: null
              CouponCode: CouponCode
              CouponLimit: 10
              EffectiveDate: '2019-10-10'
              ExpirationDate: '2030-10-10'
              NumOfTimesUsed: null
              Status: Draft
              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: patchIncentivesByParentIdCoupons
      x-operation-id-source: derived
    post:
      tags:
      - Incentive Coupons
      summary: Create incentive coupons
      description: Adds one or more incentive coupons 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 coupons to add to the collection
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/IncentiveCoupon'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/IncentiveCoupon'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/IncentiveCoupon'
      responses:
        '200':
          description: OK
      operationId: postIncentivesByParentIdCoupons
      x-operation-id-source: derived
  /incentives/{ParentId}/coupons/generate/{numberOfCoupons}:
    post:
      tags:
      - Incentive Coupons
      summary: Auto generates specified number of incentive coupons
      description: Auto generates specified number of incentive coupons. The parent incentive is automatically filled.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent incentive
        required: true
        schema:
          type: string
      - name: numberOfCoupons
        in: path
        description: Number of coupons to be generated
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
      operationId: postIncentivesByParentIdCouponsGenerateByNumberOfCoupons
      x-operation-id-source: derived
  /incentives/{ParentId}/coupons/{Id}:
    delete:
      tags:
      - Incentive Coupons
      summary: Delete an incentive coupon
      description: Deletes a single incentive coupon 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 coupon
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      operationId: deleteIncentivesByParentIdCouponsById
      x-operation-id-source: derived
    get:
      tags:
      - Incentive Coupons
      summary: Retrieve an incentive coupon
      description: Retrieves a single incentive coupon 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 coupon
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      operationId: getIncentivesByParentIdCouponsById
      x-operation-id-source: derived
    patch:
      tags:
      - Incentive Coupons
      summary: Update an incentive coupon
      description: Updates a single incentive coupon 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 coupon
        required: true
        schema:
          type: string
      requestBody:
        description: The updated state of the incentive coupon
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              Name: IncentiveCouponName
              IsActive: true
              PriceDimension:
                Id: PriceDimensionId
                Name: PriceDimensionName
              AssignedToID: null
              CouponCode: CouponCode
              CouponLimit: 10
              EffectiveDate: '2019-10-10'
              ExpirationDate: '2030-10-10'
              NumOfTimesUsed: null
              Status: Draft
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '200':
          description: OK
      operationId: patchIncentivesByParentIdCouponsById
      x-operation-id-source: derived
components:
  schemas:
    LookupObject:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
      additionalProperties: false
    IncentiveCoupon:
      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'
        IsActive:
          type:
          - boolean
          - 'null'
        PriceDimension:
          $ref: '#/components/schemas/LookupObject'
        AssignedToID:
          type:
          - string
          - 'null'
        CouponCode:
          type:
          - string
          - 'null'
        CouponLimit:
          type:
          - integer
          - 'null'
          format: int32
        EffectiveDate:
          type:
          - string
          - 'null'
          format: date-time
        ExpirationDate:
          type:
          - string
          - 'null'
          format: date-time
        Incentive:
          $ref: '#/components/schemas/LookupObject'
        NumOfTimesUsed:
          type:
          - integer
          - 'null'
          format: int32
        Status:
          type:
          - string
          - 'null'
      additionalProperties: {}
      example:
        Name: IncentiveCouponName
        IsActive: true
        PriceDimension:
          Id: PriceDimensionId
          Name: PriceDimensionName
        AssignedToID: null
        CouponCode: CouponCode
        CouponLimit: 10
        EffectiveDate: '2019-10-10'
        ExpirationDate: '2030-10-10'
        NumOfTimesUsed: null
        Status: Draft
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header