LinkedIn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LinkedIn Recruiter System Connect Application Synchronization API

3 actions 3 updates phrasing extends openapi/linkedin-application-synchronization-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 3

$.info

$.paths['/v2/atsApplications'].put

$.paths['/v2/hireMediaUrl'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for LinkedIn Recruiter System Connect Application Synchronization API
  version: 1.0.0
extends: openapi/linkedin-application-synchronization-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: 2
- target: $.paths['/v2/atsApplications'].put
  update:
    x-apievangelist-phrasing:
      intent: Sync job applications from an ATS
      effect: write
      questions:
      - Can I push job application records from my ATS into LinkedIn?
      - What happens when I sync an application that already exists?
      instructions:
      - text: Sync application {applicationId} from {dataProvider} in context {integrationContext}.
        slots:
          applicationId: query.ids[0].atsJobApplicationId
          dataProvider: query.ids[0].dataProvider
          integrationContext: query.ids[0].integrationContext
      - text: Upsert job application records {entities}.
        slots:
          entities: requestBody.entities
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/hireMediaUrl'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a signed URL for a resume upload
      effect: write
      questions:
      - Where do I upload a candidate's resume file for an application?
      - Can I set how long an uploaded resume is kept?
      instructions:
      - text: Create a resume upload URL for file {fileName} of type {contentType}.
        slots:
          fileName: requestBody.fileName
          contentType: requestBody.contentType
      - text: Get a signed resume upload URL with time-to-live {blobTtl}.
        slots:
          blobTtl: requestBody.blobTtl
      method: generated
      generated: '2026-09-26'