# 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 Scopes API
  version: 1.0.0
extends: openapi/merge-subpackage-scopes-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: 24
- target: $.paths['/accounting/v1/default-scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default accounting data scopes
      effect: read
      questions:
      - What Common Model and field permissions apply by default to every accounting Linked Account?
      - Which accounting fields does Merge sync by default before any per-account override?
      instructions:
      - text: Show the default accounting data scopes for my organization.
      - text: Get the organization-wide permission defaults for ledger integrations.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/linked-account-scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get scopes for one accounting linked account
      effect: read
      questions:
      - Which accounting models and fields is one specific Linked Account allowed to sync?
      - Can I see the effective permissions for a single connected ledger?
      instructions:
      - text: Show the accounting scopes for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Check which bookkeeping fields linked account {account_token} may read.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/linked-account-scopes'].post
  update:
    x-apievangelist-phrasing:
      intent: Override scopes for one accounting linked account
      effect: write
      questions:
      - Can I restrict which accounting fields one Linked Account syncs without touching the defaults?
      - What happens to accounting scopes I leave out when overriding a single ledger connection?
      instructions:
      - text: Override the accounting scopes of linked account {account_token} with {common_models}.
        slots:
          account_token: header.X-Account-Token
          common_models: requestBody.common_models
      - text: Apply ledger model permissions {common_models} to connection {account_token}.
        slots:
          account_token: header.X-Account-Token
          common_models: requestBody.common_models
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/default-scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default recruiting (ATS) data scopes
      effect: read
      questions:
      - What candidate and job data do all my ATS Linked Accounts sync by default?
      - Which recruiting Common Models are enabled organization-wide out of the box?
      instructions:
      - text: Show the default ATS permissions across all recruiting integrations.
      - text: List the baseline recruiting model scopes my organization uses.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/linked-account-scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get scopes for one ATS linked account
      effect: read
      questions:
      - Which candidate and application fields can one connected ATS actually sync?
      - Is a particular recruiting Linked Account allowed to read EEOC data?
      instructions:
      - text: Show the ATS scopes granted to linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Check which recruiting models connection {account_token} is permitted to pull.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/linked-account-scopes'].post
  update:
    x-apievangelist-phrasing:
      intent: Override scopes for one ATS linked account
      effect: write
      questions:
      - Can I stop one customer's ATS connection from syncing certain candidate fields?
      - Do recruiting scopes I don't set on an account fall back to the defaults?
      instructions:
      - text: Set ATS model permissions {common_models} on linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
          common_models: requestBody.common_models
      - text: Limit recruiting data for connection {account_token} to {common_models}.
        slots:
          account_token: header.X-Account-Token
          common_models: requestBody.common_models
      method: generated
      generated: '2026-09-26'
- target: $.paths['/default-scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default scopes via the root path
      effect: read
      questions:
      - Is there a default-scopes endpoint at the root path without a category prefix?
      - What does the unprefixed /default-scopes call return for my organization?
      instructions:
      - text: Call the root-level default-scopes endpoint with no category in the path.
      - text: Fetch organization default permissions from the unprefixed /default-scopes route.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/linked-account-scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get linked account scopes via the root path
      effect: read
      questions:
      - Can I read a Linked Account's scopes from the unprefixed root path?
      - What does the root-level /linked-account-scopes route show for one account?
      instructions:
      - text: Fetch scopes for account {account_token} from the root /linked-account-scopes route.
        slots:
          account_token: header.X-Account-Token
      - text: Use the category-less path to read permissions of {account_token}.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/linked-account-scopes'].post
  update:
    x-apievangelist-phrasing:
      intent: Override linked account scopes via the root path
      effect: write
      questions:
      - Can I post scope overrides to the root path instead of a category-specific one?
      - Does the unprefixed /linked-account-scopes POST also inherit defaults for unset models?
      instructions:
      - text: Post scope overrides {common_models} for {account_token} to the root /linked-account-scopes route.
        slots:
          account_token: header.X-Account-Token
          common_models: requestBody.common_models
      - text: Use the category-less path to update permissions of {account_token} to {common_models}.
        slots:
          account_token: header.X-Account-Token
          common_models: requestBody.common_models
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/default-scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default CRM data scopes
      effect: read
      questions:
      - Which contact, deal and lead fields do CRM integrations sync by default?
      - What are my organization's baseline CRM permissions?
      instructions:
      - text: Show the default CRM scopes for all sales integrations.
      - text: Get the organization-level CRM Common Model permission defaults.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/linked-account-scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get scopes for one CRM linked account
      effect: read
      questions:
      - Which CRM objects is one customer's connected CRM allowed to sync?
      - Can I check whether a single CRM Linked Account has custom scopes?
      instructions:
      - text: Show the CRM scopes for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Check which sales data connection {account_token} may read.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/linked-account-scopes'].post
  update:
    x-apievangelist-phrasing:
      intent: Override scopes for one CRM linked account
      effect: write
      questions:
      - Can I block a single CRM connection from syncing leads or notes?
      - Will CRM models I don't mention in the override keep their default permissions?
      instructions:
      - text: Override CRM scopes on linked account {account_token} with {common_models}.
        slots:
          account_token: header.X-Account-Token
          common_models: requestBody.common_models
      - text: Restrict sales data synced by {account_token} to {common_models}.
        slots:
          account_token: header.X-Account-Token
          common_models: requestBody.common_models
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/default-scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default file storage data scopes
      effect: read
      questions:
      - Which file, folder and drive fields do file storage integrations sync by default?
      - What default permissions govern every connected document store?
      instructions:
      - text: Show the default file storage scopes for my organization.
      - text: Get the baseline drive and folder permissions for all storage integrations.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/linked-account-scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get scopes for one file storage linked account
      effect: read
      questions:
      - Which files and folders fields can one connected drive sync?
      - Can I see the permissions applied to a single file storage Linked Account?
      instructions:
      - text: Show the file storage scopes for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Check which document fields drive connection {account_token} may read.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/linked-account-scopes'].post
  update:
    x-apievangelist-phrasing:
      intent: Override scopes for one file storage linked account
      effect: write
      questions:
      - Can I stop one customer's drive connection from syncing file permissions data?
      - Do storage models left out of an override inherit the defaults?
      instructions:
      - text: Set file storage permissions {common_models} for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
          common_models: requestBody.common_models
      - text: Narrow what drive connection {account_token} syncs to {common_models}.
        slots:
          account_token: header.X-Account-Token
          common_models: requestBody.common_models
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/default-scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default HRIS data scopes
      effect: read
      questions:
      - Which employee and payroll fields do HRIS integrations sync by default?
      - What are the organization-wide HR data permissions?
      instructions:
      - text: Show the default HRIS scopes across all HR integrations.
      - text: Get the baseline employee data permissions for my organization.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/linked-account-scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get scopes for one HRIS linked account
      effect: read
      questions:
      - Is one customer's HRIS connection allowed to sync compensation or SSN fields?
      - Which HR models can a single Linked Account read?
      instructions:
      - text: Show the HRIS scopes for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Check which employee fields HR connection {account_token} may sync.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/linked-account-scopes'].post
  update:
    x-apievangelist-phrasing:
      intent: Override scopes for one HRIS linked account
      effect: write
      questions:
      - Can I turn off sensitive employee fields for just one HRIS connection?
      - Do HR models I skip in an account override keep the default scopes?
      instructions:
      - text: Override HRIS scopes on linked account {account_token} with {common_models}.
        slots:
          account_token: header.X-Account-Token
          common_models: requestBody.common_models
      - text: Limit employee data synced by HR connection {account_token} to {common_models}.
        slots:
          account_token: header.X-Account-Token
          common_models: requestBody.common_models
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/default-scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default knowledge base data scopes
      effect: read
      questions:
      - Which article and container fields do knowledge base integrations sync by default?
      - What default permissions apply to every connected help center or wiki?
      instructions:
      - text: Show the default knowledge base scopes for my organization.
      - text: Get baseline article permissions for all wiki integrations.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/linked-account-scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get scopes for one knowledge base linked account
      effect: read
      questions:
      - Which articles fields can one connected knowledge base sync?
      - Can I view the permissions set on a single wiki Linked Account?
      instructions:
      - text: Show the knowledge base scopes for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Check which article data wiki connection {account_token} may read.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/linked-account-scopes'].post
  update:
    x-apievangelist-phrasing:
      intent: Override scopes for one knowledge base linked account
      effect: write
      questions:
      - Can I stop one knowledge base connection from syncing attachments?
      - Do wiki models I leave out of the override fall back to defaults?
      instructions:
      - text: Set knowledge base permissions {common_models} on linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
          common_models: requestBody.common_models
      - text: Restrict article data synced by wiki connection {account_token} to {common_models}.
        slots:
          account_token: header.X-Account-Token
          common_models: requestBody.common_models
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/default-scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default ticketing data scopes
      effect: read
      questions:
      - Which ticket, comment and user fields do ticketing integrations sync by default?
      - How do I find the baseline helpdesk permissions for my organization?
      instructions:
      - text: Show the default ticketing scopes across all helpdesk integrations.
      - text: Get the organization-wide ticket model permissions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/linked-account-scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get scopes for one ticketing linked account
      effect: read
      questions:
      - Which ticket fields can one customer's helpdesk connection sync?
      - How do I check the permissions on a single ticketing Linked Account?
      instructions:
      - text: Show the ticketing scopes for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Check which ticket data helpdesk connection {account_token} may read.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/linked-account-scopes'].post
  update:
    x-apievangelist-phrasing:
      intent: Override scopes for one ticketing linked account
      effect: write
      questions:
      - Can I prevent one helpdesk connection from syncing ticket comments?
      - Do ticketing models I omit from an override keep their default scopes?
      instructions:
      - text: Override ticketing scopes on linked account {account_token} with {common_models}.
        slots:
          account_token: header.X-Account-Token
          common_models: requestBody.common_models
      - text: Limit ticket data synced by helpdesk connection {account_token} to {common_models}.
        slots:
          account_token: header.X-Account-Token
          common_models: requestBody.common_models
      method: generated
      generated: '2026-09-26'