API Evangelist conversational phrasing for Lead Sync Use Cases > Sponsored API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lead Sync Use Cases > Sponsored API
  version: 1.0.0
extends: openapi/linkedin-use-cases-sponsored-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: 7
- target: $.paths['/organizationAcls'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a user's roles on organization pages
      effect: read
      questions:
      - Which company pages does the signed-in member hold an admin role on?
      - Can I confirm a user is allowed to pull leads for a company page before syncing?
      - Does the organization ACL lookup let me filter to only approved roles?
      instructions:
      - text: Check which organization roles the current user holds, limited to state {state}.
        slots:
          state: query.state
      - text: Validate the signed-in user's company page roles before starting lead sync.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leadForms'].get
  update:
    x-apievangelist-phrasing:
      intent: List lead gen forms for a sponsored account
      effect: read
      questions:
      - Which lead gen forms exist on the ad account I picked for lead sync?
      - Can I page through lead forms owned by one sponsored account?
      - What lead forms can my integration collect leads from on LinkedIn?
      instructions:
      - text: List the lead gen forms owned by {owner}.
        slots:
          owner: query.owner
      - text: Show the next {count} lead forms for {owner} starting at {start}.
        slots:
          count: query.count
          owner: query.owner
          start: query.start
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leadFormResponses'].get
  update:
    x-apievangelist-phrasing:
      intent: Pull lead form responses on a schedule
      effect: read
      questions:
      - How can I pull all new leads for a sponsored account on a recurring schedule?
      - Can I exclude test leads when fetching form responses?
      - Is it possible to pull only leads submitted within a certain time range?
      instructions:
      - text: Pull every lead form response for {owner} submitted in {submittedAtTimeRange}.
        slots:
          owner: query.owner
          submittedAtTimeRange: query.submittedAtTimeRange
      - text: Fetch {leadType} leads for {owner}, skipping test leads when {limitedToTestLeads} is false.
        slots:
          leadType: query.leadType
          owner: query.owner
          limitedToTestLeads: query.limitedToTestLeads
      - text: Run the periodic lead pull for {owner} with field projection {fields}.
        slots:
          owner: query.owner
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leadNotifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a webhook for new lead notifications
      effect: write
      questions:
      - Can I get a webhook call whenever a new lead form is submitted?
      - What does it take to subscribe to real-time lead notifications instead of polling?
      instructions:
      - text: Register a lead notification webhook for my sponsored account.
      - text: Subscribe my integration to push notifications for new leads.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leadFormResponses/{lead_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch one lead's full form response
      effect: read
      questions:
      - After a lead webhook fires, how do I get the full answers for that lead?
      - Can I retrieve a single form response by its lead ID?
      instructions:
      - text: Fetch the full form response for lead {lead_id}.
        slots:
          lead_id: path.lead_id
      - text: Get lead {lead_id} with only the fields {fields}.
        slots:
          lead_id: path.lead_id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leadnotifications/<webhook id>'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a registered lead notification webhook
      effect: destructive
      questions:
      - Can I remove a lead notification webhook I registered earlier?
      - What happens to lead webhooks when my integration is uninstalled?
      instructions:
      - text: Delete my registered lead notification webhook subscription.
      - text: Stop lead push notifications by removing the webhook.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adAccounts'].get
  update:
    x-apievangelist-phrasing:
      intent: Search the user's sponsored ad accounts
      effect: read
      questions:
      - Which sponsored ad accounts can the signed-in user choose from for lead sync?
      - Can I search the user's ad accounts and return only certain fields?
      instructions:
      - text: Search the user's sponsored accounts matching {search}.
        slots:
          search: query.search
      - text: List {count} sponsored ad accounts from offset {start}.
        slots:
          count: query.count
          start: query.start
      method: generated
      generated: '2026-09-26'