Unbounce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Unbounce REST Accounts API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/accounts'].get
$.paths['/accounts/{account_id}'].get
$.paths['/accounts/{account_id}/sub_accounts'].get
$.paths['/sub_accounts/{sub_account_id}'].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 Unbounce REST Accounts API
  version: 1.0.0
extends: openapi/unbounce-accounts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List the accounts I can access
      effect: read
      questions:
      - Which Unbounce accounts does my API key have access to?
      - Can I see every top-level account my login belongs to?
      instructions:
      - text: List all the accounts I have access to.
      - text: Show me my top-level accounts and their IDs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{account_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one account
      effect: read
      questions:
      - What details can I look up for a single top-level account?
      - How do I check the name and settings of one specific account?
      instructions:
      - text: Get the details of account {account_id}.
        slots:
          account_id: path.account_id
      - text: Look up top-level account {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{account_id}/sub_accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's sub-accounts
      effect: read
      questions:
      - How do I see all the sub-accounts (clients) under my account?
      - Which sub-accounts belong to a given top-level account?
      instructions:
      - text: List the sub-accounts under account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show every client sub-account in account {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sub_accounts/{sub_account_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one sub-account
      effect: read
      questions:
      - Can I look up a single sub-account by its ID?
      - What information is stored for one client sub-account?
      instructions:
      - text: Get the details of sub-account {sub_account_id}.
        slots:
          sub_account_id: path.sub_account_id
      - text: Look up client sub-account {sub_account_id}.
        slots:
          sub_account_id: path.sub_account_id
      method: generated
      generated: '2026-10-01'