Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Object Layouts Essentials Card API

5 actions 5 updates phrasing extends openapi/zendesk-essentials-card-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 5

$.info

$.paths['/api/v2/object_layouts/{object_type}/essentials_card'].get

$.paths['/api/v2/object_layouts/{object_type}/essentials_card'].put

$.paths['/api/v2/object_layouts/{object_type}/essentials_card'].delete

$.paths['/api/v2/object_layouts/essentials_cards'].get

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 Zendesk Object Layouts Essentials Card API
  version: 1.0.0
extends: openapi/zendesk-essentials-card-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: 4
- target: $.paths['/api/v2/object_layouts/{object_type}/essentials_card'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the essentials card for an object type
      effect: read
      questions:
      - What fields show on the essentials card for users?
      - How do I see the essentials card layout for one object type?
      instructions:
      - text: Show the essentials card for the user object type.
      - text: Get the essentials card layout for that custom object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/object_layouts/{object_type}/essentials_card'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an object type's essentials card
      effect: write
      questions:
      - Can I change which fields appear on the essentials card for organizations?
      - Who can update an essentials card layout?
      instructions:
      - text: Update the user essentials card to show phone and plan tier.
      - text: Change the fields on that object type's essentials card.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/object_layouts/{object_type}/essentials_card'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an object type's essentials card
      effect: destructive
      questions:
      - Can I delete the custom essentials card for an object type?
      - How do I remove an essentials card we set up for a custom object?
      instructions:
      - text: Delete the essentials card for the user object type.
      - text: Remove that custom object's essentials card.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/object_layouts/essentials_cards'].get
  update:
    x-apievangelist-phrasing:
      intent: List all essentials cards
      effect: read
      questions:
      - Which essentials cards are configured across all object types?
      - Where can I see every essentials card at once?
      instructions:
      - text: List all essentials cards.
      - text: Show the essentials cards for every object type.
      method: generated
      generated: '2026-09-26'