LinkedIn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LinkedIn Recruiter System Connect Integration Configuration API

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

$.paths['/v2/atsIntegrations'].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 Integration Configuration API
  version: 1.0.0
extends: openapi/linkedin-integration-configuration-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/atsIntegrations'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration status change notification
      effect: read
      questions:
      - What changed when a customer enabled or modified their integration?
      - Can I read the details behind an integration notification request?
      instructions:
      - text: Get the integration status change for request {requestId}.
        slots:
          requestId: query.requestId
      - text: Show what the customer changed in notification {requestId}.
        slots:
          requestId: query.requestId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/atsIntegrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a Recruiter System Connect integration
      effect: write
      questions:
      - Can I turn on One-Click Export or the profile plugin for a customer?
      - Which integration types can a partner configure for a customer?
      instructions:
      - text: Update the {integrationType} integration for {integrationContext}, tenant {tenantType}, provider {dataProvider}.
        slots:
          integrationType: query.ids[0].integrationType
          integrationContext: query.ids[0].integrationContext
          tenantType: query.ids[0].tenantType
          dataProvider: query.ids[0].dataProvider
      - text: Enable the in-ATS indicator for customer {integrationContext} with {entities}.
        slots:
          integrationContext: query.ids[0].integrationContext
          entities: requestBody.entities
      method: generated
      generated: '2026-09-26'