Generated by API Evangelist
Written by API Evangelist tooling for Gainsight's API. It is a proposal applied on top of the contract, not a document Gainsight publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Gainsight CS Renewal Center Opportunities API
version: 1.0.0
extends: openapi/gainsight-opportunities-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/data/objects/Opportunity'].put
update:
x-apievangelist-phrasing:
intent: Update opportunity records
effect: write
questions:
- Can I update existing renewal opportunities matched on a key field?
- Can I change several opportunities in one call?
instructions:
- text: 'Update these opportunities matched on {keys}: {records}.'
slots:
keys: query.keys
records: requestBody.records
- text: Edit opportunity records {records}, matching on {keys}.
slots:
records: requestBody.records
keys: query.keys
method: generated
generated: '2026-09-26'
- target: $.paths['/data/objects/Opportunity'].post
update:
x-apievangelist-phrasing:
intent: Create an opportunity
effect: write
questions:
- How do I log a renewal, upsell or downsell opportunity?
- Which booking types can a new opportunity have?
instructions:
- text: 'Create these opportunities: {records}.'
slots:
records: requestBody.records
- text: Add a new upsell opportunity record {records}.
slots:
records: requestBody.records
method: generated
generated: '2026-09-26'
- target: $.paths['/data/objects/Opportunity/search'].post
update:
x-apievangelist-phrasing:
intent: Search opportunities
effect: read
questions:
- Which renewals are closing this quarter?
- Can I filter opportunities by company or booking type?
instructions:
- text: Search opportunities where {where}.
slots:
where: requestBody.where
- text: Find up to {limit} opportunities matching {where}.
slots:
limit: requestBody.limit
where: requestBody.where
method: generated
generated: '2026-09-26'
- target: $.paths['/data/objects/Opportunity/{recordId}'].get
update:
x-apievangelist-phrasing:
intent: Get an opportunity
effect: read
questions:
- What details come back when I look up one opportunity by ID?
- What details are stored on a single opportunity?
instructions:
- text: Get opportunity {recordId}.
slots:
recordId: path.recordId
- text: Show opportunity record {recordId}.
slots:
recordId: path.recordId
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.