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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Zendesk Bookmarks API
version: 1.0.0
extends: openapi/zendesk-bookmarks-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: 3
- target: $.paths['/api/v2/bookmarks'].get
update:
x-apievangelist-phrasing:
intent: List my ticket bookmarks
effect: read
questions:
- Which tickets have I bookmarked as an agent?
- Where can I see my saved ticket bookmarks?
instructions:
- text: List my bookmarked tickets.
- text: Show all the tickets I've bookmarked.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v2/bookmarks'].post
update:
x-apievangelist-phrasing:
intent: Bookmark a ticket
effect: write
questions:
- How do I bookmark a ticket so I can find it later?
- What happens if I bookmark a ticket that's already bookmarked?
instructions:
- text: Bookmark ticket 4521 for me.
- text: Save this ticket to my bookmarks.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v2/bookmarks/{bookmark_id}'].delete
update:
x-apievangelist-phrasing:
intent: Remove a ticket bookmark
effect: destructive
questions:
- Can I remove a bookmark I no longer need?
- Can agents delete other people's bookmarks or only their own?
instructions:
- text: Remove my bookmark on ticket 4521.
- text: Delete that bookmark.
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.