# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zendesk Brands API
  version: 1.0.0
extends: openapi/zendesk-brands-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: 7
- target: $.paths['/api/v2/brands'].get
  update:
    x-apievangelist-phrasing:
      intent: List all brands
      effect: read
      questions:
      - What brands are set up in our Zendesk account?
      - Which brands can an agent without the assign-to-any-brand permission see?
      instructions:
      - text: List all brands in our account sorted by name.
      - text: Show me every brand we support tickets for.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/brands'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a brand
      effect: write
      questions:
      - How do I add a new brand for a separate product line?
      - Can I create a brand with its own subdomain through the API?
      instructions:
      - text: Create a new brand called Acme Outdoor with subdomain acmeoutdoor.
      - text: Add a brand for our new product line.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/brands/{brand_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a brand's details
      effect: read
      questions:
      - How can I see one brand's settings, like its subdomain and logo?
      - What details are returned for a single brand?
      instructions:
      - text: Show the details of the Acme Outdoor brand.
      - text: Get that brand's subdomain and host mapping.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/brands/{brand_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a brand or its logo
      effect: write
      questions:
      - Can I upload a new logo image for a brand?
      - How do I change a brand's name or host mapping?
      instructions:
      - text: Update the Acme Outdoor brand's logo with this image file.
      - text: Rename that brand and change its host mapping.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/brands/{brand_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a brand
      effect: destructive
      questions:
      - Can I delete a brand we've retired?
      - Who is allowed to remove a brand from the account?
      instructions:
      - text: Delete the retired Legacy brand.
      - text: Remove that brand from our account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/brands/{brand_id}/check_host_mapping'].get
  update:
    x-apievangelist-phrasing:
      intent: Validate host mapping for an existing brand
      effect: read
      questions:
      - Is the custom domain on one of my existing brands set up correctly?
      - How do I verify the CNAME for a brand that already exists?
      instructions:
      - text: Check whether the Acme Outdoor brand's host mapping is valid.
      - text: Verify the custom domain configured on that existing brand.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/brands/check_host_mapping'].get
  update:
    x-apievangelist-phrasing:
      intent: Validate a host mapping before creating a brand
      effect: read
      questions:
      - Before creating a brand, can I test whether a host mapping works for a subdomain?
      - Will support.example.com be a valid host mapping for a given subdomain?
      instructions:
      - text: Check if support.example.com is a valid host mapping for the subdomain I plan to use.
      - text: Test a host mapping and subdomain pair ahead of creating a new brand.
      method: generated
      generated: '2026-09-26'