UserGems · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for UserGems Accounts API

3 actions 3 updates phrasing extends openapi/usergems-accounts-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['/account'].post
$.paths['/account'].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 Accounts API
  version: 1.0.0
extends: openapi/usergems-accounts-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['/account'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a target account to source prospects for
      effect: write
      questions:
      - How do I get UserGems to start finding prospects at a target company?
      - Can I tie a newly added target account to its Salesforce account ID?
      - Which report does a new account need to go into before prospects are sourced for it?
      instructions:
      - text: Add {name} ({domain}) as a target account in report {reportId} so prospects get sourced.
        slots:
          name: requestBody.name
          domain: requestBody.domain
          reportId: requestBody.reportId
      - text: Start sourcing prospects for {domain}, named {name}, in report {reportId} under the {signal} signal.
        slots:
          domain: requestBody.domain
          name: requestBody.name
          reportId: requestBody.reportId
          signal: requestBody.signal
      - text: Queue account {name} at {domain} into report {reportId} and link it to Salesforce account {salesforceId}.
        slots:
          name: requestBody.name
          domain: requestBody.domain
          reportId: requestBody.reportId
          salesforceId: requestBody.salesforceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/account'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a target account from prospecting
      effect: destructive
      questions:
      - How can I stop getting prospects for a company I added as a target account?
      - Can I remove an account from just one report while leaving it in others?
      instructions:
      - text: Remove target account {name} ({domain}) so no more prospects are sourced for it.
        slots:
          name: query.name
          domain: query.domain
      - text: Take {name} at {domain} out of the {reportName} report only.
        slots:
          name: query.name
          domain: query.domain
          reportName: query.reportName
      method: generated
      generated: '2026-10-01'