ThriveCart · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThriveCart Customers API

3 actions 3 updates phrasing extends openapi/thrivecart-customers-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/customer'].post

$.paths['/customerEmailUpdate'].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 ThriveCart Customers API
  version: 1.0.0
extends: openapi/thrivecart-customers-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: 2
- target: $.paths['/customer'].post
  update:
    x-apievangelist-phrasing:
      intent: Read a customer's purchase history
      effect: read
      questions:
      - How do I see everything a customer has bought and subscribed to?
      - Can I look up a customer's full history by their email?
      instructions:
      - text: Get the full purchase and subscription history for {email}.
        slots:
          email: requestBody.email
      - text: Look up customer {email} and list their orders.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customerEmailUpdate'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a customer's email address
      effect: write
      questions:
      - How do I change the email address on a customer's orders?
      - What happens if the new email already belongs to another customer?
      instructions:
      - text: Change customer email {current_email} to {new_email}.
        slots:
          current_email: requestBody.current_email
          new_email: requestBody.new_email
      - text: 'Update {current_email} to {new_email} and confirm merging with the existing customer: {allow_merge}.'
        slots:
          current_email: requestBody.current_email
          new_email: requestBody.new_email
          allow_merge: requestBody.allow_merge
      method: generated
      generated: '2026-10-01'