Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Branding API

4 actions 4 updates phrasing extends openapi/live-direct-marketing-online-branding-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Live Direct Marketing's API. It is a proposal applied on top of the contract, not a document Live Direct Marketing publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/api/branding'].get
$.paths['/api/branding'].delete
$.paths['/api/branding'].patch

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 Live Direct Marketing Online Branding API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-branding-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: 3
- target: $.paths['/api/branding'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the workspace's white-label branding
      effect: read
      questions:
      - What white-label branding is applied to my workspace?
      - Which branding values come from defaults versus my own settings?
      instructions:
      - text: Show my current white-label branding.
      - text: Get the resolved branding for tenant {tenant}.
        slots:
          tenant: header.X-Tenant-Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/branding'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset white-label branding to defaults
      effect: destructive
      questions:
      - How do I throw away my custom branding and go back to the defaults?
      - Can I reset white-label settings for my workspace?
      instructions:
      - text: Reset my white-label branding to the defaults.
      - text: Clear custom branding for tenant {tenant}.
        slots:
          tenant: header.X-Tenant-Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/branding'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update white-label branding
      effect: write
      questions:
      - How do I change the logo or colors of my white-labelled workspace?
      - Can I update just part of my branding without resetting the rest?
      instructions:
      - text: Update my white-label branding settings.
      - text: Partially change branding for tenant {tenant}.
        slots:
          tenant: header.X-Tenant-Id
      method: generated
      generated: '2026-10-01'