Unbounce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Unbounce REST Leads API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/pages/{page_id}/leads'].get
$.paths['/pages/{page_id}/leads/{lead_id}'].get
$.paths['/pages/{page_id}/lead_deletion_request'].get
$.paths['/pages/{page_id}/lead_deletion_request/{lead_deletion_request_id}'].get
$.paths['/leads/{lead_id}'].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 Unbounce REST Leads API
  version: 1.0.0
extends: openapi/unbounce-leads-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: 5
- target: $.paths['/pages/{page_id}/leads'].get
  update:
    x-apievangelist-phrasing:
      intent: List the leads captured by a page
      effect: read
      questions:
      - How do I pull all the form submissions a landing page has collected?
      - Which leads came in through a specific Unbounce page?
      instructions:
      - text: List the leads captured by page {page_id}.
        slots:
          page_id: path.page_id
      - text: Export every form submission from landing page {page_id}.
        slots:
          page_id: path.page_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pages/{page_id}/leads/{lead_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one lead from a specific page
      effect: read
      questions:
      - Can I fetch a single lead scoped to the landing page it came from?
      - What did one visitor submit on a particular page's form?
      instructions:
      - text: Get lead {lead_id} from page {page_id}.
        slots:
          lead_id: path.lead_id
          page_id: path.page_id
      - text: Show the form submission {lead_id} captured on landing page {page_id}.
        slots:
          lead_id: path.lead_id
          page_id: path.page_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pages/{page_id}/lead_deletion_request'].get
  update:
    x-apievangelist-phrasing:
      intent: List lead deletion requests for a page
      effect: read
      questions:
      - How do I see which lead deletion requests have been made for a page?
      - Can I check the status of all requests to delete leads from a landing page?
      instructions:
      - text: List the lead deletion requests for page {page_id}.
        slots:
          page_id: path.page_id
      - text: Show all pending and completed lead deletion requests on page {page_id}.
        slots:
          page_id: path.page_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pages/{page_id}/lead_deletion_request/{lead_deletion_request_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check one lead deletion request
      effect: read
      questions:
      - Has a particular lead deletion request finished processing?
      - What is the status of one specific request to delete leads?
      instructions:
      - text: Get lead deletion request {lead_deletion_request_id} on page {page_id}.
        slots:
          lead_deletion_request_id: path.lead_deletion_request_id
          page_id: path.page_id
      - text: Check whether deletion request {lead_deletion_request_id} for page {page_id} is complete.
        slots:
          lead_deletion_request_id: path.lead_deletion_request_id
          page_id: path.page_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/leads/{lead_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a lead by its ID
      effect: read
      questions:
      - Can I look up a lead by its ID alone, without knowing which page it came from?
      - What fields did a given lead submit?
      instructions:
      - text: Get lead {lead_id}.
        slots:
          lead_id: path.lead_id
      - text: Look up lead {lead_id} directly by its ID.
        slots:
          lead_id: path.lead_id
      method: generated
      generated: '2026-10-01'