# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Merge Subpackage Link Token API
  version: 1.0.0
extends: openapi/merge-subpackage-linktoken-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: 9
- target: $.paths['/accounting/v1/link-token'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Link token for accounting integrations
      effect: write
      questions:
      - How do I start the flow that lets a customer connect their accounting software?
      - Can the accounting Link token pre-select one specific ledger integration?
      instructions:
      - text: Create an accounting link token for {end_user_email_address} at {end_user_organization_name}, user ID {end_user_origin_id}, categories {categories}.
        slots:
          end_user_email_address: requestBody.end_user_email_address
          end_user_organization_name: requestBody.end_user_organization_name
          end_user_origin_id: requestBody.end_user_origin_id
          categories: requestBody.categories
      - text: Issue a ledger linking token for customer {end_user_origin_id} preselecting {integration}.
        slots:
          end_user_origin_id: requestBody.end_user_origin_id
          integration: requestBody.integration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/registered-users/{registered_user_id}/link-token/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a connector link token for a registered user
      effect: write
      questions:
      - Can I generate a magic link so an Agent Handler registered user can authenticate a connector in their browser?
      - Where does the user land after finishing connector authentication if I set a callback URL?
      instructions:
      - text: Generate a link token for registered user {registered_user_id} to connect {connector}.
        slots:
          registered_user_id: path.registered_user_id
          connector: requestBody.connector
      - text: Create a {connector} auth link for registered user {registered_user_id} redirecting to {callback_url}.
        slots:
          registered_user_id: path.registered_user_id
          connector: requestBody.connector
          callback_url: requestBody.callback_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/link-token'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Link token for ATS integrations
      effect: write
      questions:
      - What do I need to let a customer connect their applicant tracking system?
      - Can a recruiting Link token also return a shareable Magic Link URL?
      instructions:
      - text: Create an ATS link token for recruiter {end_user_email_address} of {end_user_organization_name} (ID {end_user_origin_id}) in {categories}.
        slots:
          end_user_email_address: requestBody.end_user_email_address
          end_user_organization_name: requestBody.end_user_organization_name
          end_user_origin_id: requestBody.end_user_origin_id
          categories: requestBody.categories
      - text: Start ATS linking for customer {end_user_origin_id} with a magic link set to {should_create_magic_link_url}.
        slots:
          end_user_origin_id: requestBody.end_user_origin_id
          should_create_magic_link_url: requestBody.should_create_magic_link_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/link-token'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Link token via the root path
      effect: write
      questions:
      - Is there a root-level link-token endpoint without a category in the path?
      - Can I choose the integration categories shown in Link from the unprefixed endpoint?
      instructions:
      - text: Call the root /link-token route for {end_user_email_address}, org {end_user_organization_name}, origin {end_user_origin_id}, categories {categories}.
        slots:
          end_user_email_address: requestBody.end_user_email_address
          end_user_organization_name: requestBody.end_user_organization_name
          end_user_origin_id: requestBody.end_user_origin_id
          categories: requestBody.categories
      - text: Use the category-less path to make a linking token valid for {link_expiry_mins} minutes.
        slots:
          link_expiry_mins: requestBody.link_expiry_mins
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/link-token'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Link token for CRM integrations
      effect: write
      questions:
      - How can a customer connect their CRM through the embedded linking flow?
      - Can I set how long a CRM Link token stays valid?
      instructions:
      - text: Create a CRM link token for {end_user_email_address} from {end_user_organization_name}, origin ID {end_user_origin_id}, categories {categories}.
        slots:
          end_user_email_address: requestBody.end_user_email_address
          end_user_organization_name: requestBody.end_user_organization_name
          end_user_origin_id: requestBody.end_user_origin_id
          categories: requestBody.categories
      - text: Start CRM linking in language {language} for customer {end_user_origin_id}.
        slots:
          language: requestBody.language
          end_user_origin_id: requestBody.end_user_origin_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/link-token'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Link token for file storage integrations
      effect: write
      questions:
      - What does a customer need to connect their cloud drive through Link?
      - Can I disable syncing for a file storage account at link time?
      instructions:
      - text: Create a file storage link token for {end_user_email_address} at {end_user_organization_name}, ID {end_user_origin_id}, categories {categories}.
        slots:
          end_user_email_address: requestBody.end_user_email_address
          end_user_organization_name: requestBody.end_user_organization_name
          end_user_origin_id: requestBody.end_user_origin_id
          categories: requestBody.categories
      - text: Start drive linking for {end_user_origin_id} with syncs disabled set to {are_syncs_disabled}.
        slots:
          end_user_origin_id: requestBody.end_user_origin_id
          are_syncs_disabled: requestBody.are_syncs_disabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/link-token'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Link token for HRIS integrations
      effect: write
      questions:
      - How do I let a customer connect their HR or payroll system?
      - Can I limit which employee fields sync when creating an HRIS Link token?
      instructions:
      - text: Create an HRIS link token for admin {end_user_email_address} of {end_user_organization_name}, ID {end_user_origin_id}, categories {categories}.
        slots:
          end_user_email_address: requestBody.end_user_email_address
          end_user_organization_name: requestBody.end_user_organization_name
          end_user_origin_id: requestBody.end_user_origin_id
          categories: requestBody.categories
      - text: Start HR system linking for {end_user_origin_id} with model scopes {common_models}.
        slots:
          end_user_origin_id: requestBody.end_user_origin_id
          common_models: requestBody.common_models
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/link-token'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Link token for knowledge base integrations
      effect: write
      questions:
      - How can a customer connect their help center or wiki for syncing?
      - Can a knowledge base Link token be tied to an existing credential?
      instructions:
      - text: Create a knowledge base link token for {end_user_email_address}, org {end_user_organization_name}, ID {end_user_origin_id}, categories {categories}.
        slots:
          end_user_email_address: requestBody.end_user_email_address
          end_user_organization_name: requestBody.end_user_organization_name
          end_user_origin_id: requestBody.end_user_origin_id
          categories: requestBody.categories
      - text: Start wiki linking for {end_user_origin_id} using credential {credential_id}.
        slots:
          end_user_origin_id: requestBody.end_user_origin_id
          credential_id: requestBody.credential_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/link-token'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Link token for ticketing integrations
      effect: write
      questions:
      - What's needed to let a customer connect their helpdesk or issue tracker?
      - Can a ticketing Link token enable External Key Management for the account?
      instructions:
      - text: Create a ticketing link token for {end_user_email_address} at {end_user_organization_name}, ID {end_user_origin_id}, categories {categories}.
        slots:
          end_user_email_address: requestBody.end_user_email_address
          end_user_organization_name: requestBody.end_user_organization_name
          end_user_origin_id: requestBody.end_user_origin_id
          categories: requestBody.categories
      - text: Start helpdesk linking for {end_user_origin_id} with EKM set to {ekm_enabled}.
        slots:
          end_user_origin_id: requestBody.end_user_origin_id
          ekm_enabled: requestBody.ekm_enabled
      method: generated
      generated: '2026-09-26'