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 PX REST User Preferences API
version: 1.0.0
extends: openapi/gainsight-user-preferences-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: 4
- target: $.paths['/v1/user/preferences'].put
update:
x-apievangelist-phrasing:
intent: Update preferences for a user ID in the body
effect: write
questions:
- My user's identify ID has special characters, so how can I update their preferences?
- Can I opt a user out of surveys by passing their ID in the request body?
instructions:
- text: 'Update preferences for user {identifyId} (ID in body): surveys {surveys}.'
slots:
identifyId: requestBody.identifyId
surveys: requestBody.surveys
- text: Turn guided tours {guidedTours} for body-identified user {identifyId}.
slots:
guidedTours: requestBody.guidedTours
identifyId: requestBody.identifyId
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/user/preferences'].post
update:
x-apievangelist-phrasing:
intent: Read preferences for a user ID in the body
effect: read
questions:
- How do I read a user's preferences when their ID can't go in the URL?
- Is there a POST lookup for user preferences?
instructions:
- text: Look up preferences for user {identifyId}, passing the ID in the body.
slots:
identifyId: requestBody.identifyId
- text: Fetch the opt-in settings of body-identified user {identifyId}.
slots:
identifyId: requestBody.identifyId
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/user/preferences/{identifyId}'].get
update:
x-apievangelist-phrasing:
intent: Get a user's preferences
effect: read
questions:
- Has a user opted out of usage tracking or product updates?
- What communication preferences does a user have set?
instructions:
- text: Get the preferences of user {identifyId}.
slots:
identifyId: path.identifyId
- text: Show whether user {identifyId} allows surveys and guided tours.
slots:
identifyId: path.identifyId
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/user/preferences/{identifyId}'].put
update:
x-apievangelist-phrasing:
intent: Update a user's preferences
effect: write
questions:
- How do I stop tracking usage for a user who opted out?
- Can I change only one preference and leave the others?
instructions:
- text: Set track usage to {trackUsage} for user {identifyId}.
slots:
trackUsage: requestBody.trackUsage
identifyId: path.identifyId
- text: 'Update user {identifyId}: product updates {productUpdates}, onboarding bot {onboardingBot}.'
slots:
identifyId: path.identifyId
productUpdates: requestBody.productUpdates
onboardingBot: requestBody.onboardingBot
method: generated
generated: '2026-10-01'
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.