Common Room · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Common Room API (v2) Lead Scores API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/lead-scores/{id}'].get
$.paths['/lead-scores'].get

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 Common Room API (v2) Lead Scores API
  version: 1.0.0
extends: openapi/common-room-lead-scores-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['/lead-scores/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a lead score definition by ID
      effect: read
      questions:
      - Can I see how one specific ls_ lead score is defined?
      - What's the name of the lead score with a given ID?
      instructions:
      - text: Get lead score definition {id}.
        slots:
          id: path.id
      - text: Show me how lead score {id} is set up.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lead-scores'].get
  update:
    x-apievangelist-phrasing:
      intent: List all lead score definitions
      effect: read
      questions:
      - What lead scores have we defined in our community?
      - Which lead score IDs can I sort contacts or organizations by?
      instructions:
      - text: List all of our lead score definitions.
      - text: Show every lead score we've configured.
      method: generated
      generated: '2026-10-01'