Lusha · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Lusha API Documentation Contacts Tables API

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

What the actions change

x-apievangelist-phrasing

Targets 12

$.info
$.paths['/v3/contacts/tables'].post
$.paths['/v3/contacts/tables/list'].post
$.paths['/v3/contacts/tables/{table_id}'].get
$.paths['/v3/contacts/tables/{table_id}'].delete
$.paths['/v3/contacts/tables/{table_id}'].patch
$.paths['/v3/contacts/tables/{table_id}/entities'].get
$.paths['/v3/contacts/tables/{table_id}/entities'].post
$.paths['/v3/contacts/tables/{table_id}/entities'].delete
$.paths['/v3/contacts/tables/{table_id}/columns'].get
$.paths['/v3/contacts/tables/{table_id}/columns/{column_id}'].delete
$.paths['/v3/contacts/tables/{table_id}/columns/{column_id}/run'].post

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 Lusha API Documentation Contacts Tables API
  version: 1.0.0
extends: openapi/lusha-contacts-tables-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: 11
- target: $.paths['/v3/contacts/tables'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contacts table
      effect: write
      questions:
      - How do I start a new people list table in Lusha?
      - Can I pre-load a new contacts table with contact IDs?
      - Does it cost credits to create a contacts table?
      instructions:
      - text: Create a contacts table named {name} owned by {owner}.
        slots:
          name: requestBody.name
          owner: requestBody.owner
      - text: Make a contacts table called {name} for {owner} starting with contacts {ids}.
        slots:
          name: requestBody.name
          owner: requestBody.owner
          ids: requestBody.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/contacts/tables/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List contacts tables
      effect: read
      questions:
      - Which contacts tables are mine or shared with my account?
      - Can I look up a people table by name?
      - How do I page through every contacts table I have?
      instructions:
      - text: List the contacts tables owned by {owner}.
        slots:
          owner: requestBody.owner
      - text: Find contacts tables for {owner} named like {name}.
        slots:
          owner: requestBody.owner
          name: requestBody.name
      - text: List contacts tables for {owner} in status {status}.
        slots:
          owner: requestBody.owner
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/contacts/tables/{table_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contacts table and its status
      effect: read
      questions:
      - Has my contacts table finished processing yet?
      - What details can I see about one people table?
      instructions:
      - text: Show the details of contacts table {table_id}.
        slots:
          table_id: path.table_id
      - text: Check if contacts table {table_id} is still processing.
        slots:
          table_id: path.table_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/contacts/tables/{table_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contacts table
      effect: destructive
      questions:
      - How do I permanently delete a contacts table?
      - Is deleting a people table reversible?
      instructions:
      - text: Delete contacts table {table_id} and everything in it.
        slots:
          table_id: path.table_id
      - text: Permanently remove contacts table {table_id} on behalf of {email}.
        slots:
          table_id: path.table_id
          email: query.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/contacts/tables/{table_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename, archive or reassign a contacts table
      effect: write
      questions:
      - How do I rename a contacts table?
      - Can I archive a people table or hand it to another owner?
      - Can I make a contacts table private or shared after creating it?
      instructions:
      - text: Rename contacts table {table_id} to {name} as owner {owner}.
        slots:
          table_id: path.table_id
          name: requestBody.name
          owner: requestBody.owner
      - text: Archive contacts table {table_id}, owned by {owner}.
        slots:
          table_id: path.table_id
          owner: requestBody.owner
      - text: Change the visibility of contacts table {table_id} to {visibility}, owner {owner}.
        slots:
          table_id: path.table_id
          visibility: requestBody.visibility
          owner: requestBody.owner
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/contacts/tables/{table_id}/entities'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the rows of a contacts table
      effect: read
      questions:
      - How do I export the people and column values from a contacts table?
      - Does reading rows from a contacts table cost credits?
      - Can I read a big people table one page at a time?
      instructions:
      - text: Show the rows in contacts table {table_id}.
        slots:
          table_id: path.table_id
      - text: Get page {page} of contacts table {table_id} with {size} rows per page.
        slots:
          page: query.page
          table_id: path.table_id
          size: query.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/contacts/tables/{table_id}/entities'].post
  update:
    x-apievangelist-phrasing:
      intent: Add contacts to a table
      effect: write
      questions:
      - How do I add more people to an existing contacts table?
      - How many contact IDs can I add to a table per request?
      - What happens if I add a contact that's already in the table?
      instructions:
      - text: Add contacts {entityIds} to contacts table {table_id} as owner {owner}.
        slots:
          entityIds: requestBody.entityIds
          table_id: path.table_id
          owner: requestBody.owner
      - text: 'Put these people into table {table_id}: {entityIds}, owner {owner}.'
        slots:
          table_id: path.table_id
          entityIds: requestBody.entityIds
          owner: requestBody.owner
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/contacts/tables/{table_id}/entities'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove contacts from a table
      effect: destructive
      questions:
      - How do I take specific people out of a contacts table?
      - Can I remove several contact rows at once without deleting the table?
      instructions:
      - text: Remove contacts {entityIds} from contacts table {table_id} as owner {owner}.
        slots:
          entityIds: requestBody.entityIds
          table_id: path.table_id
          owner: requestBody.owner
      - text: 'Drop these people from table {table_id}: {entityIds}, owner {owner}.'
        slots:
          table_id: path.table_id
          entityIds: requestBody.entityIds
          owner: requestBody.owner
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/contacts/tables/{table_id}/columns'].get
  update:
    x-apievangelist-phrasing:
      intent: List the columns on a contacts table
      effect: read
      questions:
      - What columns are on my contacts table?
      - How many cells per column in a people table succeeded or failed?
      instructions:
      - text: List the columns on contacts table {table_id}.
        slots:
          table_id: path.table_id
      - text: Show each column's type and cell status counts in contacts table {table_id}.
        slots:
          table_id: path.table_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/contacts/tables/{table_id}/columns/{column_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a column from a contacts table
      effect: destructive
      questions:
      - How do I delete a column and its data from a contacts table?
      - Can I remove a default Lusha column from a people table?
      instructions:
      - text: Remove column {column_id} from contacts table {table_id}.
        slots:
          column_id: path.column_id
          table_id: path.table_id
      - text: Delete column {column_id} with all of its cells in contacts table {table_id}.
        slots:
          column_id: path.column_id
          table_id: path.table_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/contacts/tables/{table_id}/columns/{column_id}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Populate or refresh a contacts table column
      effect: write
      questions:
      - How do I fill a column's data for every person in a contacts table?
      - Can I refresh a contacts table column for only selected rows?
      - How can I tell when a column run on a people table is done?
      instructions:
      - text: Run column {column_id} on contacts table {table_id} with scope {runScope} as owner {owner}.
        slots:
          column_id: path.column_id
          table_id: path.table_id
          runScope: requestBody.runScope
          owner: requestBody.owner
      - text: Refresh column {column_id} in contacts table {table_id} for people {entityIds}, scope {runScope}, owner {owner}.
        slots:
          column_id: path.column_id
          table_id: path.table_id
          entityIds: requestBody.entityIds
          runScope: requestBody.runScope
          owner: requestBody.owner
      method: generated
      generated: '2026-09-26'