Leadping · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Leadping Organizations API

22 actions 22 updates phrasing extends openapi/leadping-organizations-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 22 · first 16 shown; the file carries all of them

$.info
$.paths['/organizations/me'].get
$.paths['/organizations/me'].put
$.paths['/organizations/me'].post
$.paths['/organizations/me/options'].get
$.paths['/organizations/me/switch'].post
$.paths['/organizations/me/members'].get
$.paths['/organizations/me/members'].post
$.paths['/organizations/me/members/{userId}'].put
$.paths['/organizations/me/members/{userId}'].delete
$.paths['/organizations/me/membership'].delete
$.paths['/organizations/me/invitations'].get
$.paths['/organizations/me/invitations'].post
$.paths['/organizations/me/invitations/{invitationId}/resend'].post
$.paths['/organizations/me/invitations/{invitationId}'].delete
$.paths['/organizations/me/10dlc/notes'].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 Organizations API
  version: 1.0.0
extends: openapi/leadping-organizations-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: 21
- target: $.paths['/organizations/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my organization profile
      effect: read
      questions:
      - What settings does my current organization have?
      - How do I see my organization's account profile?
      instructions:
      - text: Show my current organization profile.
      - text: Get my organization's settings and billing context.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/me'].put
  update:
    x-apievangelist-phrasing:
      intent: Update my organization profile
      effect: write
      questions:
      - How do I change my organization's name or website?
      - Can I add our EIN to the organization profile?
      instructions:
      - text: Rename my organization to {name}.
        slots:
          name: requestBody.name
      - text: Update my organization's website to {website} and phone to {phone}.
        slots:
          website: requestBody.website
          phone: requestBody.phone
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/me'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new organization
      effect: write
      questions:
      - How do I start a brand new organization account and become its owner?
      - Can I set up a second organization for another business?
      instructions:
      - text: Create a new organization named {name}.
        slots:
          name: requestBody.name
      - text: Start a new organization {name} in the {vertical} vertical.
        slots:
          name: requestBody.name
          vertical: requestBody.vertical
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/me/options'].get
  update:
    x-apievangelist-phrasing:
      intent: List organizations I can switch to
      effect: read
      questions:
      - Which organizations do I belong to?
      - What role do I have in each organization I can switch into?
      instructions:
      - text: List the organizations I can switch to.
      - text: Show my organization memberships and roles.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/me/switch'].post
  update:
    x-apievangelist-phrasing:
      intent: Switch my active organization
      effect: write
      questions:
      - How do I change which organization I'm working in?
      - Can I switch context to another organization I'm a member of?
      instructions:
      - text: Switch to organization {organizationId}.
        slots:
          organizationId: requestBody.organizationId
      - text: Make {organizationId} my active organization.
        slots:
          organizationId: requestBody.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/me/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization members
      effect: read
      questions:
      - Who are the members of my organization?
      - What roles do my teammates have?
      instructions:
      - text: List the members of my organization.
      - text: Show everyone on my team and their roles.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/me/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an existing user to my organization
      effect: write
      questions:
      - How do I add an existing Leadping user to my organization directly?
      - Can I choose the role when adding someone to my team?
      instructions:
      - text: Add {email} to my organization as {role}.
        slots:
          email: requestBody.email
          role: requestBody.role
      - text: Add user {userId} to my organization.
        slots:
          userId: requestBody.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/me/members/{userId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a member's role
      effect: write
      questions:
      - How do I promote a teammate to admin?
      - Can I change what someone on my team has access to?
      instructions:
      - text: Change user {userId}'s role to {role}.
        slots:
          userId: path.userId
          role: requestBody.role
      - text: Make member {userId} a {role} in my organization.
        slots:
          userId: path.userId
          role: requestBody.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/me/members/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from my organization
      effect: destructive
      questions:
      - How do I kick someone out of my organization?
      - Does removing a member revoke their access to our leads?
      instructions:
      - text: Remove user {userId} from my organization.
        slots:
          userId: path.userId
      - text: Revoke member {userId}'s access to the organization.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/me/membership'].delete
  update:
    x-apievangelist-phrasing:
      intent: Leave my current organization
      effect: destructive
      questions:
      - How do I leave an organization I no longer work with?
      - Will leaving an organization cancel its subscription?
      instructions:
      - text: Leave my current organization.
      - text: Remove myself from this organization.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/me/invitations'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization invitations
      effect: read
      questions:
      - Which invitations to my organization are still pending?
      - When do the invitations I sent expire?
      instructions:
      - text: List my organization's invitations.
      - text: Show pending and past team invites.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/me/invitations'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite someone to my organization
      effect: write
      questions:
      - How do I invite a new teammate by email?
      - Can I set the role someone will have before they accept?
      instructions:
      - text: Invite {email} to my organization.
        slots:
          email: requestBody.email
      - text: Send an invitation to {email} with the {role} role.
        slots:
          email: requestBody.email
          role: requestBody.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/me/invitations/{invitationId}/resend'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend an invitation
      effect: write
      questions:
      - My teammate lost their invite email; can I send it again?
      - Does resending an invitation keep the same role?
      instructions:
      - text: Resend invitation {invitationId}.
        slots:
          invitationId: path.invitationId
      - text: Send invite {invitationId} again.
        slots:
          invitationId: path.invitationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/me/invitations/{invitationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an invitation
      effect: destructive
      questions:
      - How do I cancel an invitation I sent by mistake?
      - Can I stop someone from using a pending invite?
      instructions:
      - text: Revoke invitation {invitationId}.
        slots:
          invitationId: path.invitationId
      - text: Cancel pending invite {invitationId}.
        slots:
          invitationId: path.invitationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/me/10dlc/notes'].put
  update:
    x-apievangelist-phrasing:
      intent: Update 10DLC registration notes
      effect: write
      questions:
      - Where do I keep notes for our 10DLC carrier registration?
      - Can I update the messaging compliance notes shared with my team?
      instructions:
      - text: 'Set our 10DLC notes to: {notes}.'
        slots:
          notes: requestBody.notes
      - text: Update the organization's 10DLC registration notes with {notes}.
        slots:
          notes: requestBody.notes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/api-keys/my'].post
  update:
    x-apievangelist-phrasing:
      intent: List organization API keys
      effect: read
      questions:
      - Which API keys exist for my organization?
      - Can I search my organization's API keys by name?
      instructions:
      - text: List my organization's API keys.
      - text: Find API keys matching {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/api-keys/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API key's details
      effect: read
      questions:
      - How do I check the details of one API key without exposing the secret?
      - When was a given API key created and what can it do?
      instructions:
      - text: Show API key {id}.
        slots:
          id: path.id
      - text: Get the safe details for API key {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/api-keys/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue an organization API key
      effect: write
      questions:
      - How do I create a new API key for my organization?
      - Can I make an API key that expires after a set number of days?
      instructions:
      - text: Issue an API key named {name} for organization {id}.
        slots:
          name: requestBody.name
          id: path.id
      - text: Create a key for organization {id} that expires in {expiresInDays} days.
        slots:
          id: path.id
          expiresInDays: requestBody.expiresInDays
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/api-keys/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API key
      effect: destructive
      questions:
      - How do I revoke an API key that leaked?
      - Will deleting an API key affect the organization itself?
      instructions:
      - text: Delete API key {id}.
        slots:
          id: path.id
      - text: Revoke API key {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/invitations/token/{token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an invitation by token
      effect: read
      questions:
      - Which organization is an invite token for?
      - How do I check an invitation's role and expiry from its token?
      instructions:
      - text: Look up the invitation for token {token}.
        slots:
          token: path.token
      - text: Show which organization invite token {token} belongs to.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/invitations/accept'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept an organization invitation
      effect: write
      questions:
      - How do I join an organization I was invited to?
      - What do I need to accept a team invite?
      instructions:
      - text: Accept the invitation with token {token}.
        slots:
          token: requestBody.token
      - text: Join the organization using invite token {token} as {firstName} {lastName}.
        slots:
          token: requestBody.token
          firstName: requestBody.firstName
          lastName: requestBody.lastName
      method: generated
      generated: '2026-09-26'