Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Dynamic Content Dynamic Content Item Variants API

8 actions 8 updates phrasing extends openapi/zendesk-dynamic-content-item-variants-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Zendesk's API. It is a proposal applied on top of the contract, not a document Zendesk publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}/variants'].get
$.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}/variants'].post
$.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}/variants/{dynamic_content_variant_id}'].get
$.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}/variants/{dynamic_content_variant_id}'].put
$.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}/variants/{dynamic_content_variant_id}'].delete
$.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}/variants/create_many'].post
$.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}/variants/update_many'].put

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 Zendesk Dynamic Content Dynamic Content Item Variants API
  version: 1.0.0
extends: openapi/zendesk-dynamic-content-item-variants-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/dynamic_content/items/{dynamic_content_item_id}/variants'].get
  update:
    x-apievangelist-phrasing:
      intent: List a dynamic content item's variants
      effect: read
      questions:
      - Which language variants exist for a dynamic content item?
      - Can I see every locale version of one dynamic content item?
      instructions:
      - text: List the variants of this dynamic content item.
      - text: Show all locale variants for one item.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}/variants'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a locale variant to dynamic content
      effect: write
      questions:
      - Can I add a translation for a new locale to a dynamic content item?
      - What happens if a variant for that locale already exists?
      instructions:
      - text: Add a French variant to this dynamic content item.
      - text: Create one new locale variant for the item.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}/variants/{dynamic_content_variant_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dynamic content variant
      effect: read
      questions:
      - How do I see the text of one specific dynamic content variant?
      - Where can I look up a single variant by its id?
      instructions:
      - text: Show this dynamic content variant.
      - text: Get the content of one variant of the item.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}/variants/{dynamic_content_variant_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a dynamic content variant
      effect: write
      questions:
      - Can I change just the content of one variant?
      - Why can't I deactivate the default variant?
      instructions:
      - text: Update the content of this variant.
      - text: Change the text of one locale variant.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}/variants/{dynamic_content_variant_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dynamic content variant
      effect: destructive
      questions:
      - Can I remove one locale variant from a dynamic content item?
      - Is deleting a single variant permanent?
      instructions:
      - text: Delete this dynamic content variant.
      - text: Remove one locale variant from the item.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}/variants/create_many'].post
  update:
    x-apievangelist-phrasing:
      intent: Add several variants to dynamic content
      effect: write
      questions:
      - Can I add several locale variants to an item in one call?
      - Is there a bulk create for dynamic content variants?
      instructions:
      - text: Add these variants to the dynamic content item in one request.
      - text: Create Spanish and German variants for the item at once.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/dynamic_content/items/{dynamic_content_item_id}/variants/update_many'].put
  update:
    x-apievangelist-phrasing:
      intent: Update several variants at once
      effect: write
      questions:
      - Can I update multiple variants of an item in one request?
      - How do I specify which variants to change in a bulk update?
      instructions:
      - text: Bulk update these variants by id.
      - text: Change several locale variants of the item at once.
      method: generated
      generated: '2026-09-26'