LinkedIn · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/linkedin-candidate-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/atsCandidates'].get

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

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 Candidate Synchronization API
  version: 1.0.0
extends: openapi/linkedin-candidate-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/atsCandidates'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve candidate matches with members
      effect: read
      questions:
      - Which LinkedIn members has a synced ATS candidate been matched to?
      - Can I see both algorithmic and user-supplied matches for a candidate?
      instructions:
      - text: Retrieve matches for candidate {candidateId} from {dataProvider} in {integrationContext}.
        slots:
          candidateId: query.ids[0].atsCandidateId
          dataProvider: query.ids[0].dataProvider
          integrationContext: query.ids[0].integrationContext
      - text: Show member matches for ATS candidate {candidateId}.
        slots:
          candidateId: query.ids[0].atsCandidateId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/atsCandidates'].put
  update:
    x-apievangelist-phrasing:
      intent: Sync candidates from an ATS
      effect: write
      questions:
      - Can I push candidate records from my ATS into LinkedIn?
      - Does syncing a candidate update an existing record?
      instructions:
      - text: Sync candidate {candidateId} from {dataProvider} in {integrationContext}.
        slots:
          candidateId: query.ids[0].atsCandidateId
          dataProvider: query.ids[0].dataProvider
          integrationContext: query.ids[0].integrationContext
      - text: Upsert candidate records {entities}.
        slots:
          entities: requestBody.entities
      method: generated
      generated: '2026-09-26'