Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Merge Subpackage Account Token API

17 actions 17 updates phrasing extends openapi/merge-subpackage-accounttoken-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Merge's API. It is a proposal applied on top of the contract, not a document Merge publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 17 · first 16 shown; the file carries all of them

$.info
$.paths['/accounting/v1/account-token/{public_token}'].get
$.paths['/accounting/v1/account-token/regenerate'].post
$.paths['/ats/v1/account-token/{public_token}'].get
$.paths['/ats/v1/account-token/regenerate'].post
$.paths['/account-token/{public_token}'].get
$.paths['/account-token/regenerate'].post
$.paths['/crm/v1/account-token/{public_token}'].get
$.paths['/crm/v1/account-token/regenerate'].post
$.paths['/filestorage/v1/account-token/{public_token}'].get
$.paths['/filestorage/v1/account-token/regenerate'].post
$.paths['/hris/v1/account-token/{public_token}'].get
$.paths['/hris/v1/account-token/regenerate'].post
$.paths['/knowledgebase/v1/account-token/{public_token}'].get
$.paths['/knowledgebase/v1/account-token/regenerate'].post
$.paths['/ticketing/v1/account-token/{public_token}'].get

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 Merge Subpackage Account Token API
  version: 1.0.0
extends: openapi/merge-subpackage-accounttoken-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: 16
- target: $.paths['/accounting/v1/account-token/{public_token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an accounting linked account's account token
      effect: read
      questions:
      - How do I exchange an accounting integration's public token for an account token?
      - Which account token belongs to the user who just linked their accounting software?
      instructions:
      - text: Exchange accounting public token {public_token} for its account token.
        slots:
          public_token: path.public_token
      - text: Look up the ledger connection's account token using public token {public_token}.
        slots:
          public_token: path.public_token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/account-token/regenerate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate an accounting linked account's token
      effect: destructive
      questions:
      - Can I rotate the account token of a connected accounting platform?
      - Is there a way to issue a fresh token for a bookkeeping integration?
      instructions:
      - text: Regenerate the account token for accounting linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Swap out my accounting integration's token for a new one.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/account-token/{public_token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a recruiting linked account's account token
      effect: read
      questions:
      - What account token do I get after a customer links their applicant tracking system?
      - Can I trade an ATS public token for the permanent account token?
      instructions:
      - text: Exchange ATS public token {public_token} for its account token.
        slots:
          public_token: path.public_token
      - text: Retrieve the recruiting integration token for public token {public_token}.
        slots:
          public_token: path.public_token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/account-token/regenerate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a recruiting linked account's token
      effect: destructive
      questions:
      - How do I regenerate the token for a linked applicant tracking system?
      - Can a hiring-platform connection get a brand new account token?
      instructions:
      - text: Regenerate the account token for ATS linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Issue a replacement token for my recruiting integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-token/{public_token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a chat linked account's account token
      effect: read
      questions:
      - How do I turn a chat integration's public token into an account token?
      - Which account token was issued when a user connected their messaging workspace?
      instructions:
      - text: Exchange chat public token {public_token} for its account token.
        slots:
          public_token: path.public_token
      - text: Fetch the messaging workspace token behind public token {public_token}.
        slots:
          public_token: path.public_token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account-token/regenerate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a chat linked account's token
      effect: destructive
      questions:
      - Can I rotate the account token of a linked chat workspace?
      - Is it possible to reissue the token for a messaging integration?
      instructions:
      - text: Regenerate the account token for chat linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Rotate the token on my messaging workspace connection.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/account-token/{public_token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a CRM linked account's account token
      effect: read
      questions:
      - What account token maps to the public token from a CRM link flow?
      - Can I retrieve the account token once a sales team connects its CRM?
      instructions:
      - text: Exchange CRM public token {public_token} for its account token.
        slots:
          public_token: path.public_token
      - text: Get the sales-system account token for public token {public_token}.
        slots:
          public_token: path.public_token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/account-token/regenerate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a CRM linked account's token
      effect: destructive
      questions:
      - How can I generate a new account token for a connected CRM?
      - Can I replace a leaked CRM integration token?
      instructions:
      - text: Regenerate the account token for CRM linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Give my CRM connection a fresh account token.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/account-token/{public_token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a file storage linked account's account token
      effect: read
      questions:
      - Which account token corresponds to a file storage public token?
      - How do I finish linking a cloud drive by fetching its account token?
      instructions:
      - text: Exchange file storage public token {public_token} for its account token.
        slots:
          public_token: path.public_token
      - text: Retrieve the drive integration's account token for {public_token}.
        slots:
          public_token: path.public_token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/account-token/regenerate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a file storage linked account's token
      effect: destructive
      questions:
      - Can I regenerate the token for a linked file storage account?
      - Is there a way to reset the credentials token on a cloud drive connection?
      instructions:
      - text: Regenerate the account token for file storage linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Rotate the token on my document storage integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/account-token/{public_token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an HRIS linked account's account token
      effect: read
      questions:
      - What account token is issued when a company links its HR system?
      - Can I exchange an HRIS public token for the long-lived account token?
      instructions:
      - text: Exchange HRIS public token {public_token} for its account token.
        slots:
          public_token: path.public_token
      - text: Look up the HR platform account token for public token {public_token}.
        slots:
          public_token: path.public_token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/account-token/regenerate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate an HRIS linked account's token
      effect: destructive
      questions:
      - How do I issue a new token for a linked payroll or HR system?
      - Can an HRIS connection's account token be regenerated?
      instructions:
      - text: Regenerate the account token for HRIS linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Replace the token on my HR system integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/account-token/{public_token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a knowledge base linked account's token
      effect: read
      questions:
      - Which account token belongs to a newly linked knowledge base?
      - How do I convert a help-center public token into an account token?
      instructions:
      - text: Exchange knowledge base public token {public_token} for its account token.
        slots:
          public_token: path.public_token
      - text: Fetch the help center connection's account token for {public_token}.
        slots:
          public_token: path.public_token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/account-token/regenerate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a knowledge base linked account's token
      effect: destructive
      questions:
      - Can I rotate the token for a connected knowledge base?
      - Is regenerating a documentation wiki's account token supported?
      instructions:
      - text: Regenerate the account token for knowledge base linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Issue a new token for my wiki integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/account-token/{public_token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a ticketing linked account's account token
      effect: read
      questions:
      - What account token do I receive after a helpdesk is linked?
      - Can I swap a ticketing public token for its account token?
      instructions:
      - text: Exchange ticketing public token {public_token} for its account token.
        slots:
          public_token: path.public_token
      - text: Get the issue tracker's account token for public token {public_token}.
        slots:
          public_token: path.public_token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/account-token/regenerate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a ticketing linked account's token
      effect: destructive
      questions:
      - How do I regenerate the account token for a linked helpdesk?
      - Can a ticketing integration be given a new token after a leak?
      instructions:
      - text: Regenerate the account token for ticketing linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Rotate the token on my issue tracker connection.
      method: generated
      generated: '2026-09-26'