LinkedIn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Use Cases > InMail Content API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/rest/inMailContents/'].post
$.paths['/rest/inMailContents/{adInMailContentId}'].get
$.paths['/rest/inMailContents/{adInMailContentId}'].post
$.paths['/rest/inMailContents'].get
$.paths['/rest/inMailContents'].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 Use Cases > InMail Content API
  version: 1.0.0
extends: openapi/linkedin-use-cases-inmail-content-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: 5
- target: $.paths['/rest/inMailContents/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create InMail ad content
      effect: write
      questions:
      - Can I create the message content for a sponsored InMail?
      - What's the first step in building a Message Ad's InMail body?
      instructions:
      - text: Create new InMail content for my message ad.
      - text: Draft a sponsored InMail content item.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/inMailContents/{adInMailContentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one InMail content item
      effect: read
      questions:
      - What does a specific InMail content item contain?
      - Can I retrieve a single sponsored InMail by its ID?
      instructions:
      - text: Get InMail content {adInMailContentId}.
        slots:
          adInMailContentId: path.adInMailContentId
      - text: Show the subject and body of InMail {adInMailContentId}.
        slots:
          adInMailContentId: path.adInMailContentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/inMailContents/{adInMailContentId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an InMail content item
      effect: write
      questions:
      - Can I edit an InMail's content after creating it?
      - Is it possible to change the subject line of an existing InMail?
      instructions:
      - text: Update InMail content {adInMailContentId}.
        slots:
          adInMailContentId: path.adInMailContentId
      - text: Change the message text of InMail {adInMailContentId}.
        slots:
          adInMailContentId: path.adInMailContentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/inMailContents'].get
  update:
    x-apievangelist-phrasing:
      intent: Batch get InMail content items
      effect: read
      questions:
      - Can I fetch several InMail contents in one request?
      - Which InMail items belong to a set of IDs I have?
      instructions:
      - text: Batch get InMail contents {ids}.
        slots:
          ids: query.ids
      - text: Retrieve the InMail content items {ids} together.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/inMailContents'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test InMail
      effect: write
      questions:
      - Can I send myself a test copy of an InMail before launch?
      - Is there a way to preview a sponsored InMail in a real inbox on LinkedIn?
      instructions:
      - text: Send a test InMail using action {action}.
        slots:
          action: query.action
      - text: Share a test copy of my InMail content to check how it looks.
      method: generated
      generated: '2026-09-26'