Ortto · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ortto Accounts API

2 actions 2 updates phrasing extends openapi/ortto-accounts-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Ortto's API. It is a proposal applied on top of the contract, not a document Ortto publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/accounts/merge'].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 Ortto Accounts API
  version: 1.0.0
extends: openapi/ortto-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: 1
- target: $.paths['/accounts/merge'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update company accounts
      effect: write
      questions:
      - How do I add or update organizations (accounts) in Ortto from my CRM?
      - Can I upsert several company accounts at once and match existing ones by a field?
      - What happens to existing account values when I merge new company data?
      instructions:
      - text: 'Create or update these company accounts: {accounts}.'
        slots:
          accounts: requestBody.accounts
      - text: Upsert accounts {accounts}, matching existing companies by {merge_by}.
        slots:
          accounts: requestBody.accounts
          merge_by: requestBody.merge_by
      - text: Merge accounts {accounts} using merge strategy {merge_strategy} so existing company fields are handled my way.
        slots:
          accounts: requestBody.accounts
          merge_strategy: requestBody.merge_strategy
      method: generated
      generated: '2026-10-01'