Leadping · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Leadping Users API

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

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/users/me/paymentmethod'].get
$.paths['/users/me'].get
$.paths['/users/me'].put
$.paths['/users/me/notification-preferences'].put
$.paths['/users/change-billing-plan'].put
$.paths['/users/compliance'].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 Leadping Users API
  version: 1.0.0
extends: openapi/leadping-users-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: 6
- target: $.paths['/users/me/paymentmethod'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my default payment method
      effect: read
      questions:
      - Which card is my default for billing?
      - How do I see my own saved payment method?
      instructions:
      - text: Show my default payment method.
      - text: Tell me which card is my default.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my user profile
      effect: read
      questions:
      - What does my Leadping user profile contain?
      - Which roles and organization am I signed in with?
      instructions:
      - text: Show my user profile.
      - text: Get my account roles and billing state.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/me'].put
  update:
    x-apievangelist-phrasing:
      intent: Update my user profile
      effect: write
      questions:
      - How do I change my name or phone on my profile?
      - Can I set my time zone?
      instructions:
      - text: Update my phone to {phone}.
        slots:
          phone: requestBody.phone
      - text: Set my name to {firstName} {lastName} with phone {phone}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          phone: requestBody.phone
      - text: Change my time zone to {timeZoneId}, keeping phone {phone}.
        slots:
          timeZoneId: requestBody.timeZoneId
          phone: requestBody.phone
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/me/notification-preferences'].put
  update:
    x-apievangelist-phrasing:
      intent: Update my notification preferences
      effect: write
      questions:
      - How do I get texted when a new lead comes in?
      - Can I turn off email alerts for missed calls?
      - Which alerts can I get about a low wallet balance?
      instructions:
      - text: Turn new lead SMS alerts {newLeadSmsEnabled}.
        slots:
          newLeadSmsEnabled: requestBody.newLeadSmsEnabled
      - text: Set missed call email notifications to {missedCallEmailEnabled}.
        slots:
          missedCallEmailEnabled: requestBody.missedCallEmailEnabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/change-billing-plan'].put
  update:
    x-apievangelist-phrasing:
      intent: Change my billing plan
      effect: write
      questions:
      - How do I upgrade or downgrade my Leadping plan?
      - Can I switch to a different billing plan?
      instructions:
      - text: Change my billing plan to {billingPlan}.
        slots:
          billingPlan: requestBody.billingPlan
      - text: Switch me to the {billingPlan} plan.
        slots:
          billingPlan: requestBody.billingPlan
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/compliance'].put
  update:
    x-apievangelist-phrasing:
      intent: Update my compliance settings
      effect: write
      questions:
      - How do I update the compliance info needed to send messages?
      - What compliance settings affect my messaging eligibility?
      instructions:
      - text: Update my compliance settings with {compliance}.
        slots:
          compliance: requestBody.compliance
      - text: Save compliance details {compliance} from source {source}.
        slots:
          compliance: requestBody.compliance
          source: requestBody.source
      method: generated
      generated: '2026-09-26'