Conga · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Conga Quote API
15 actions
15 updates
phrasing
extends
openapi/conga-quote-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
What the actions change
x-apievangelist-phrasing
Targets 15
$.info
$.paths['/api/cart/v1/quotes/{quoteId}/carts/activate'].post
$.paths['/api/cart/v1/quotes/{quoteId}/carts/active'].get
$.paths['/quotes'].get
$.paths['/quotes'].post
$.paths['/quotes'].delete
$.paths['/quotes'].patch
$.paths['/quotes/upsert-quote'].post
$.paths['/quotes/{ExternalId}/clone-quote'].post
$.paths['/quotes/{Id}'].get
$.paths['/quotes/{Id}'].delete
$.paths['/quotes/{Id}'].patch
$.paths['/quotes/{Id}/accept'].post
$.paths['/quotes/{Id}/agreement'].post
$.paths['/quotes/{Id}/clone'].post
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Conga Quote API
version: 1.0.0
extends: openapi/conga-quote-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 14
- target: $.paths['/api/cart/v1/quotes/{quoteId}/carts/activate'].post
update:
x-apievangelist-phrasing:
intent: Launch the cart for a quote
effect: write
questions:
- How do I open a shopping cart to configure products on a quote?
- Can I launch a quote's cart while skipping the approval check or deal guidance?
instructions:
- text: Launch the cart for quote {quoteId}.
slots:
quoteId: path.quoteId
- text: 'Activate a cart on quote {quoteId} and skip deal guidance: {skipDealGuidance}.'
slots:
quoteId: path.quoteId
skipDealGuidance: requestBody.skipDealGuidance
method: generated
generated: '2026-10-01'
- target: $.paths['/api/cart/v1/quotes/{quoteId}/carts/active'].get
update:
x-apievangelist-phrasing:
intent: Get a quote's active cart
effect: read
questions:
- Which cart is currently active on a quote?
- Can I check whether a quote already has an open cart?
instructions:
- text: Get the active cart for quote {quoteId}.
slots:
quoteId: path.quoteId
- text: Show me which cart is open on quote {quoteId} right now.
slots:
quoteId: path.quoteId
method: generated
generated: '2026-10-01'
- target: $.paths['/quotes'].get
update:
x-apievangelist-phrasing:
intent: List quotes
effect: read
questions:
- What quotes do we have in Conga CPQ?
- Can I filter and sort the list of quotes?
instructions:
- text: List all quotes.
- text: List quotes matching {filter}, sorted by {sort}.
slots:
filter: query.filter
sort: query.sort
method: generated
generated: '2026-10-01'
- target: $.paths['/quotes'].post
update:
x-apievangelist-phrasing:
intent: Create one or more quotes
effect: write
questions:
- How do I create new quotes and get their IDs back?
- Can I create several quotes in a single request?
instructions:
- text: Create new quotes from these details.
- text: Create several quotes at once and return their IDs.
method: generated
generated: '2026-10-01'
- target: $.paths['/quotes'].delete
update:
x-apievangelist-phrasing:
intent: Delete several quotes
effect: destructive
questions:
- Can I delete a batch of quote records at once?
- Is there a bulk delete for old quotes?
instructions:
- text: Delete these quotes in bulk.
- text: Remove several quote records in one request.
method: generated
generated: '2026-10-01'
- target: $.paths['/quotes'].patch
update:
x-apievangelist-phrasing:
intent: Update several quotes
effect: write
questions:
- Can I change fields on many quotes in one request?
- Is there a bulk update for quote records?
instructions:
- text: Update these quotes in bulk.
- text: Apply these field changes to several quotes at once.
method: generated
generated: '2026-10-01'
- target: $.paths['/quotes/upsert-quote'].post
update:
x-apievangelist-phrasing:
intent: Upsert a quote
effect: write
questions:
- Can I create a quote or update it if it already exists in one call?
- What's the upsert option for syncing a quote?
instructions:
- text: Upsert this quote, updating it if it already exists.
- text: Insert or update the quote with these details.
method: generated
generated: '2026-10-01'
- target: $.paths['/quotes/{ExternalId}/clone-quote'].post
update:
x-apievangelist-phrasing:
intent: Clone a quote by its external ID
effect: write
questions:
- Can I copy a quote when I only know its external quote ID?
- When cloning by external ID, can I choose whether line items come along?
instructions:
- text: Clone the quote with external ID {ExternalId}.
slots:
ExternalId: path.ExternalId
- text: 'Clone external quote {ExternalId}, copying line items: {cloneLineItems}.'
slots:
ExternalId: path.ExternalId
cloneLineItems: query.cloneLineItems
method: generated
generated: '2026-10-01'
- target: $.paths['/quotes/{Id}'].get
update:
x-apievangelist-phrasing:
intent: Retrieve a quote
effect: read
questions:
- How can I see the details of one quote?
- Can I pull a quote along with related records?
instructions:
- text: Get quote {Id}.
slots:
Id: path.Id
- text: Show quote {Id} including {includes}.
slots:
Id: path.Id
includes: query.includes
method: generated
generated: '2026-10-01'
- target: $.paths['/quotes/{Id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a quote
effect: destructive
questions:
- Can I delete just one quote by its ID?
- What happens when I remove a single quote record?
instructions:
- text: Delete quote {Id}.
slots:
Id: path.Id
- text: Remove the single quote record {Id}.
slots:
Id: path.Id
method: generated
generated: '2026-10-01'
- target: $.paths['/quotes/{Id}'].patch
update:
x-apievangelist-phrasing:
intent: Update a quote
effect: write
questions:
- How do I change the details on one quote?
- Can I edit a single quote without touching others?
instructions:
- text: Update quote {Id} with these changes.
slots:
Id: path.Id
- text: Edit the single quote {Id}.
slots:
Id: path.Id
method: generated
generated: '2026-10-01'
- target: $.paths['/quotes/{Id}/accept'].post
update:
x-apievangelist-phrasing:
intent: Accept a quote and create an order
effect: write
questions:
- How do I turn an approved quote into an order?
- Can accepting a quote run asynchronously, and what stage is the new order in?
instructions:
- text: Accept quote {Id} and create its order.
slots:
Id: path.Id
- text: 'Accept quote {Id} asynchronously: {IsAsync}.'
slots:
Id: path.Id
IsAsync: query.IsAsync
method: generated
generated: '2026-10-01'
- target: $.paths['/quotes/{Id}/agreement'].post
update:
x-apievangelist-phrasing:
intent: Create an agreement from a quote
effect: write
questions:
- Can I generate a contract agreement straight from a quote?
- When creating an agreement from a quote, can I override field values?
instructions:
- text: Create an agreement from quote {Id}.
slots:
Id: path.Id
- text: Create an agreement from quote {Id} with override values {OverrideValues}.
slots:
Id: path.Id
OverrideValues: requestBody.OverrideValues
method: generated
generated: '2026-10-01'
- target: $.paths['/quotes/{Id}/clone'].post
update:
x-apievangelist-phrasing:
intent: Clone a quote by its internal ID
effect: write
questions:
- How do I duplicate an existing quote using its Conga quote ID?
- Can I clone a quote without copying its line items?
instructions:
- text: Clone quote {Id}.
slots:
Id: path.Id
- text: 'Copy quote {Id}, cloning line items: {cloneLineItems}.'
slots:
Id: path.Id
cloneLineItems: query.cloneLineItems
method: generated
generated: '2026-10-01'