# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Clerk Backend Waitlist Entries API
  version: 1.0.0
extends: openapi/clerk-com-waitlist-entries-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: 6
- target: $.paths['/waitlist_entries'].get
  update:
    x-apievangelist-phrasing:
      intent: List waitlist entries
      effect: read
      questions:
      - Who is on the waitlist for my app?
      - Can I filter the waitlist to only pending or rejected entries?
      - How do I search the waitlist by email address?
      instructions:
      - text: List all waitlist entries.
      - text: Show waitlist entries with status {status}.
        slots:
          status: query.status
      - text: Search the waitlist for {query}.
        slots:
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/waitlist_entries'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an email to the waitlist
      effect: write
      questions:
      - How do I add someone to my app's waitlist from the backend?
      - What happens if an email is already on the waitlist?
      instructions:
      - text: Add {email_address} to the waitlist.
        slots:
          email_address: requestBody.email_address
      - text: 'Put {email_address} on the waitlist without a confirmation email: notify {notify}.'
        slots:
          email_address: requestBody.email_address
          notify: requestBody.notify
      method: generated
      generated: '2026-09-26'
- target: $.paths['/waitlist_entries/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Add many emails to the waitlist
      effect: write
      questions:
      - How do I import a list of signups onto the waitlist in one call?
      - Does bulk waitlist creation send confirmation emails by default?
      instructions:
      - text: Add this list of email addresses to the waitlist in bulk.
      - text: Bulk-create waitlist entries for these signups without notifying them.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/waitlist_entries/{waitlist_entry_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pending waitlist entry
      effect: destructive
      questions:
      - How do I remove someone from the waitlist who is still pending?
      - Can I delete a waitlist entry that has not been invited yet?
      instructions:
      - text: Delete waitlist entry {waitlist_entry_id}.
        slots:
          waitlist_entry_id: path.waitlist_entry_id
      - text: Remove pending entry {waitlist_entry_id} from the waitlist.
        slots:
          waitlist_entry_id: path.waitlist_entry_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/waitlist_entries/{waitlist_entry_id}/invite'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite someone off the waitlist
      effect: write
      questions:
      - How do I let a waitlisted person in by sending them an invite?
      - Can I invite a waitlist entry even if they already have an invitation?
      instructions:
      - text: Invite waitlist entry {waitlist_entry_id}.
        slots:
          waitlist_entry_id: path.waitlist_entry_id
      - text: 'Send an invite to waitlisted {waitlist_entry_id}, ignoring existing invites: {ignore_existing}.'
        slots:
          waitlist_entry_id: path.waitlist_entry_id
          ignore_existing: requestBody.ignore_existing
      method: generated
      generated: '2026-09-26'
- target: $.paths['/waitlist_entries/{waitlist_entry_id}/reject'].post
  update:
    x-apievangelist-phrasing:
      intent: Reject a waitlist entry
      effect: destructive
      questions:
      - How do I turn down someone on the waitlist?
      - Can I mark a waitlist entry as rejected instead of deleting it?
      instructions:
      - text: Reject waitlist entry {waitlist_entry_id}.
        slots:
          waitlist_entry_id: path.waitlist_entry_id
      - text: Decline the waitlisted signup {waitlist_entry_id}.
        slots:
          waitlist_entry_id: path.waitlist_entry_id
      method: generated
      generated: '2026-09-26'