UserGems · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for UserGems Contacts API

3 actions 3 updates phrasing extends openapi/usergems-contacts-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for UserGems's API. It is a proposal applied on top of the contract, not a document UserGems publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/contact'].post
$.paths['/contact'].delete

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 UserGems Contacts API
  version: 1.0.0
extends: openapi/usergems-contacts-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: 2
- target: $.paths['/contact'].post
  update:
    x-apievangelist-phrasing:
      intent: Track a contact for job changes
      effect: write
      questions:
      - How do I get alerted when a champion or customer contact changes jobs?
      - Can I tag a tracked contact as a Champion or User so job changes are bucketed?
      - What do I need besides an email address to start tracking someone's job moves?
      instructions:
      - text: Start tracking {email} for job changes.
        slots:
          email: requestBody.email
      - text: Track {email} at {company} as a {relationshipType} contact for job changes.
        slots:
          email: requestBody.email
          company: requestBody.company
          relationshipType: requestBody.relationshipType
      - text: Add {fullName} ({email}, LinkedIn {linkedinUrl}) to job-change tracking.
        slots:
          fullName: requestBody.fullName
          email: requestBody.email
          linkedinUrl: requestBody.linkedinUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contact'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop tracking a contact for job changes
      effect: destructive
      questions:
      - How do I stop watching a person for job changes?
      - Can I untrack someone only as a Champion but keep tracking them under another relationship type?
      instructions:
      - text: Stop tracking {email} for job changes.
        slots:
          email: query.email
      - text: Remove {email} from job-change tracking under the {relationshipType} bucket only.
        slots:
          email: query.email
          relationshipType: query.relationshipType
      - text: Untrack {email} for the {signal} signal and leave its other signals alone.
        slots:
          email: query.email
          signal: query.signal
      method: generated
      generated: '2026-10-01'