Gainsight · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gainsight PX REST UserPreferences V2 API

5 actions 5 updates phrasing extends openapi/gainsight-userpreferences-v2-api-openapi.yml
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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v2/user/preferences'].put
$.paths['/v2/user/preferences'].post
$.paths['/v2/user/preferences/{identifyId}'].get
$.paths['/v2/user/preferences/{identifyId}'].put

OpenAPI Overlay

Raw ↑ 
# 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 UserPreferences V2 API
  version: 1.0.0
extends: openapi/gainsight-userpreferences-v2-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['/v2/user/preferences'].put
  update:
    x-apievangelist-phrasing:
      intent: Update v2 preferences with the user ID in the body
      effect: write
      questions:
      - How do I set email analytics tracking for a user whose ID can't go in the URL?
      - Can the v2 body-based update change trackEmailAnalytics?
      instructions:
      - text: Set email analytics tracking to {trackEmailAnalytics} for user {identifyId}, ID in body.
        slots:
          trackEmailAnalytics: requestBody.trackEmailAnalytics
          identifyId: requestBody.identifyId
      - text: 'Update v2 preferences of body-identified user {identifyId}: surveys {surveys}.'
        slots:
          identifyId: requestBody.identifyId
          surveys: requestBody.surveys
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user/preferences'].post
  update:
    x-apievangelist-phrasing:
      intent: Read v2 preferences with the user ID in the body
      effect: read
      questions:
      - Is there a v2 POST lookup that includes email analytics preferences?
      - Where can I read trackEmailAnalytics for a user with an awkward ID?
      instructions:
      - text: Look up v2 preferences for user {identifyId}, passing the ID in the body.
        slots:
          identifyId: requestBody.identifyId
      - text: Fetch email analytics consent of body-identified user {identifyId}.
        slots:
          identifyId: requestBody.identifyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user/preferences/{identifyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's v2 preferences
      effect: read
      questions:
      - Has a user allowed email analytics tracking?
      - What does the v2 preferences read return beyond the v1 version?
      instructions:
      - text: Get v2 preferences for user {identifyId}.
        slots:
          identifyId: path.identifyId
      - text: Show whether user {identifyId} permits email analytics.
        slots:
          identifyId: path.identifyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/user/preferences/{identifyId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user's v2 preferences
      effect: write
      questions:
      - Can I turn off email analytics for one user?
      - Can the v2 update change just the trackEmailAnalytics flag?
      instructions:
      - text: Set trackEmailAnalytics to {trackEmailAnalytics} for user {identifyId}.
        slots:
          trackEmailAnalytics: requestBody.trackEmailAnalytics
          identifyId: path.identifyId
      - text: 'Update v2 preferences for {identifyId}: track usage {trackUsage}.'
        slots:
          identifyId: path.identifyId
          trackUsage: requestBody.trackUsage
      method: generated
      generated: '2026-09-26'