Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Blocked Phone Numbers API

8 actions 8 updates phrasing extends openapi/close-blocked-phone-numbers-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Close's API. It is a proposal applied on top of the contract, not a document Close publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/blocked_phone_number/'].get
$.paths['/blocked_phone_number/'].post
$.paths['/blocked_phone_number/settings/'].get
$.paths['/blocked_phone_number/settings/'].put
$.paths['/blocked_phone_number/{id}/'].get
$.paths['/blocked_phone_number/{id}/'].put
$.paths['/blocked_phone_number/{id}/'].delete

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 Close Blocked Phone Numbers API
  version: 1.0.0
extends: openapi/close-blocked-phone-numbers-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['/blocked_phone_number/'].get
  update:
    x-apievangelist-phrasing:
      intent: List blocked phone numbers
      effect: read
      questions:
      - Which phone numbers are blocked in my organization?
      - Can I page through the block list of phone numbers?
      instructions:
      - text: List all blocked phone numbers.
      - text: Show {limit} blocked numbers from the block list.
        slots:
          limit: query._limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/blocked_phone_number/'].post
  update:
    x-apievangelist-phrasing:
      intent: Block a phone number
      effect: write
      questions:
      - How do I stop a phone number from calling us or being called?
      - Can I block a spam caller and record the reason?
      instructions:
      - text: Block phone number {phone} because {reason}.
        slots:
          phone: requestBody.phone
          reason: requestBody.reason
      - text: Add {phone} to the blocked numbers list with reason {reason}.
        slots:
          phone: requestBody.phone
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/blocked_phone_number/settings/'].get
  update:
    x-apievangelist-phrasing:
      intent: View call blocking settings
      effect: read
      questions:
      - Are anonymous inbound calls currently rejected for my organization?
      - What are my blocked phone number settings?
      instructions:
      - text: Show my blocked phone number settings.
      - text: Tell me whether anonymous inbound calls are being rejected.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/blocked_phone_number/settings/'].put
  update:
    x-apievangelist-phrasing:
      intent: Toggle rejecting anonymous inbound calls
      effect: write
      questions:
      - Can I automatically reject calls from anonymous or hidden numbers?
      - How do I turn off rejection of anonymous inbound calls?
      instructions:
      - text: Set reject anonymous inbound calls to {reject_anonymous_inbound_calls}.
        slots:
          reject_anonymous_inbound_calls: requestBody.reject_anonymous_inbound_calls
      - text: Start rejecting inbound calls from anonymous callers.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/blocked_phone_number/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one blocked phone number
      effect: read
      questions:
      - Why was a specific phone number blocked?
      - Can I look up a single blocked number record by id?
      instructions:
      - text: Fetch blocked phone number record {id}.
        slots:
          id: path.id
      - text: Show the reason on block entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/blocked_phone_number/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the reason a number is blocked
      effect: write
      questions:
      - Can I edit the reason recorded on a blocked phone number?
      - Is it possible to update a block entry without unblocking the number?
      instructions:
      - text: Change the reason on blocked number {id} to {reason}.
        slots:
          id: path.id
          reason: requestBody.reason
      - text: Update block entry {id} with reason {reason}.
        slots:
          id: path.id
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/blocked_phone_number/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unblock a phone number
      effect: destructive
      questions:
      - How can I let a previously blocked number call us again?
      - What happens when I remove a number from the block list?
      instructions:
      - text: Unblock the phone number in block entry {id}.
        slots:
          id: path.id
      - text: Delete blocked phone number record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'