Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online LinkedIn API

14 actions 14 updates phrasing extends openapi/live-direct-marketing-online-linked-in-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Live Direct Marketing's API. It is a proposal applied on top of the contract, not a document Live Direct Marketing publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 14

$.info
$.paths['/api/linkedin/integration'].get
$.paths['/api/linkedin/integration'].patch
$.paths['/api/linkedin/accounts'].get
$.paths['/api/linkedin/accounts/{id}'].get
$.paths['/api/linkedin/accounts/{id}'].patch
$.paths['/api/linkedin/accounts/{id}/disconnect'].post
$.paths['/api/linkedin/campaigns'].get
$.paths['/api/linkedin/campaigns'].post
$.paths['/api/linkedin/campaigns/{id}'].patch
$.paths['/api/linkedin/campaigns/{id}/leads'].post
$.paths['/api/linkedin/scenarios'].get
$.paths['/api/linkedin/scenarios'].post
$.paths['/api/linkedin/stats'].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 Live Direct Marketing Online LinkedIn API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-linked-in-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: 13
- target: $.paths['/api/linkedin/integration'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the LinkedIn integration status
      effect: read
      questions:
      - Is the LinkedIn outreach module turned on for my workspace?
      - What defaults are set on the LinkedIn integration?
      instructions:
      - text: Show the LinkedIn integration status.
      - text: Tell me whether the LinkedIn module is enabled and what its defaults are.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/linkedin/integration'].patch
  update:
    x-apievangelist-phrasing:
      intent: Enable, disable or kill-switch LinkedIn outreach
      effect: write
      questions:
      - How do I switch off all LinkedIn activity at once with the kill-switch?
      - Can I change the default settings for the LinkedIn module?
      instructions:
      - text: Enable the LinkedIn module.
      - text: Flip the LinkedIn kill-switch to stop all outreach.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/linkedin/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List connected LinkedIn accounts
      effect: read
      questions:
      - Which LinkedIn accounts are connected for outreach?
      - What LinkedIn sender profiles do I have available?
      instructions:
      - text: List my connected LinkedIn accounts.
      - text: Show all LinkedIn sender accounts in this workspace.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/linkedin/accounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one LinkedIn account
      effect: read
      questions:
      - What limits and sending windows are set on one LinkedIn account?
      - Is a particular LinkedIn account paused?
      instructions:
      - text: Show LinkedIn account {id}.
        slots:
          id: path.id
      - text: Get the settings of LinkedIn sender {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/linkedin/accounts/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a LinkedIn account's limits or pause it
      effect: write
      questions:
      - Can I lower the daily action limits on a LinkedIn account?
      - How do I pause one LinkedIn account or change its working hours?
      instructions:
      - text: Pause LinkedIn account {id}.
        slots:
          id: path.id
      - text: Change the limits and sending windows of LinkedIn account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/linkedin/accounts/{id}/disconnect'].post
  update:
    x-apievangelist-phrasing:
      intent: Disconnect a LinkedIn account session
      effect: destructive
      questions:
      - How do I revoke a LinkedIn session and erase its stored cookies?
      - Can I disconnect a LinkedIn account from outreach?
      instructions:
      - text: Disconnect LinkedIn account {id}.
        slots:
          id: path.id
      - text: Revoke the session and wipe cookies for LinkedIn account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/linkedin/campaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List LinkedIn campaigns
      effect: read
      questions:
      - What LinkedIn outreach campaigns are running?
      - Which LinkedIn campaigns have I set up?
      instructions:
      - text: List my LinkedIn campaigns.
      - text: Show every LinkedIn outreach campaign.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/linkedin/campaigns'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a LinkedIn campaign
      effect: write
      questions:
      - How do I start a new LinkedIn outreach campaign?
      - Can I create a LinkedIn campaign that follows a scenario?
      instructions:
      - text: Create a new LinkedIn campaign.
      - text: Set up a LinkedIn outreach campaign for me.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/linkedin/campaigns/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a LinkedIn campaign's name, status or scenario
      effect: write
      questions:
      - Can I pause a LinkedIn campaign or switch it to a different scenario?
      - How do I rename a LinkedIn campaign?
      instructions:
      - text: Update LinkedIn campaign {id}.
        slots:
          id: path.id
      - text: Change the status of LinkedIn campaign {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/linkedin/campaigns/{id}/leads'].post
  update:
    x-apievangelist-phrasing:
      intent: Add leads to a LinkedIn campaign
      effect: write
      questions:
      - How do I load leads into a LinkedIn campaign?
      - Can I feed new prospects into an existing LinkedIn campaign?
      instructions:
      - text: Pour leads into LinkedIn campaign {id}.
        slots:
          id: path.id
      - text: Add a batch of prospects to LinkedIn campaign {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/linkedin/scenarios'].get
  update:
    x-apievangelist-phrasing:
      intent: List LinkedIn outreach scenarios
      effect: read
      questions:
      - What LinkedIn outreach scenarios are available to attach to a campaign?
      - Which step-by-step LinkedIn flows have I defined?
      instructions:
      - text: List my LinkedIn scenarios.
      - text: Show the LinkedIn outreach flows I can use.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/linkedin/scenarios'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a LinkedIn outreach scenario
      effect: write
      questions:
      - How do I define a new LinkedIn outreach flow, like connect then message?
      - Can I build a reusable LinkedIn scenario?
      instructions:
      - text: Create a LinkedIn scenario.
      - text: Build a new reusable LinkedIn outreach flow.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/linkedin/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get LinkedIn funnel and reply-rate stats
      effect: read
      questions:
      - What is my LinkedIn connection acceptance rate?
      - How many LinkedIn prospects replied across the funnel?
      instructions:
      - text: Show the LinkedIn outreach dashboard stats.
      - text: Report my LinkedIn funnel with acceptance and reply rates.
      method: generated
      generated: '2026-10-01'