Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Scheduling Links API

15 actions 15 updates phrasing extends openapi/close-scheduling-links-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 15

$.info

$.paths['/scheduling_link/'].get

$.paths['/scheduling_link/'].post

$.paths['/scheduling_link/integration/'].post

$.paths['/scheduling_link/integration/{source_id}/'].delete

$.paths['/scheduling_link/{id}/'].get

$.paths['/scheduling_link/{id}/'].put

$.paths['/scheduling_link/{id}/'].delete

$.paths['/shared_scheduling_link/'].get

$.paths['/shared_scheduling_link/'].post

$.paths['/shared_scheduling_link/{id}/'].get

$.paths['/shared_scheduling_link/{id}/'].put

$.paths['/shared_scheduling_link/{id}/'].delete

$.paths['/shared_scheduling_link_association/'].post

$.paths['/shared_scheduling_link_association/unmap/'].post

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 Close Scheduling Links API
  version: 1.0.0
extends: openapi/close-scheduling-links-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: 14
- target: $.paths['/scheduling_link/'].get
  update:
    x-apievangelist-phrasing:
      intent: List my personal scheduling links
      effect: read
      questions:
      - Which personal booking links do I have set up in Close?
      - Can I see all of my own user scheduling links in one list?
      instructions:
      - text: List all of my user scheduling links.
      - text: Show me every personal meeting booking link I've created.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduling_link/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a personal scheduling link
      effect: write
      questions:
      - How do I add a new personal booking link for my meetings?
      - Can I register my own calendar booking URL as a user scheduling link?
      instructions:
      - text: Create a new user scheduling link for me.
      - text: Add a personal scheduling link so prospects can book time with me.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduling_link/integration/'].post
  update:
    x-apievangelist-phrasing:
      intent: Upsert a scheduling link from an OAuth app
      effect: write
      questions:
      - Can my OAuth integration create or update a user's scheduling link by its source id?
      - What happens if my app pushes a scheduling link with a source id that already exists?
      instructions:
      - text: Sync my OAuth app's scheduling link into Close, creating it or updating the one with the same source id.
      - text: Upsert an integration-managed user scheduling link through the OAuth app.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduling_link/integration/{source_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an OAuth app's scheduling link by source id
      effect: destructive
      questions:
      - Can my OAuth app remove a scheduling link it created using its own source id?
      - Which call deletes an integration-managed scheduling link rather than one I made by hand?
      instructions:
      - text: Delete the integration scheduling link with source id {source_id}.
        slots:
          source_id: path.source_id
      - text: Remove the OAuth-managed booking link {source_id} from Close.
        slots:
          source_id: path.source_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduling_link/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch one personal scheduling link
      effect: read
      questions:
      - What are the details of a specific user scheduling link?
      - Can I look up one of my booking links by its id?
      instructions:
      - text: Fetch user scheduling link {id}.
        slots:
          id: path.id
      - text: Show me the details of my personal booking link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduling_link/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a personal scheduling link
      effect: write
      questions:
      - Can I change the name or URL of an existing personal booking link?
      - Is it possible to edit a user scheduling link after creating it?
      instructions:
      - text: Update my user scheduling link {id}.
        slots:
          id: path.id
      - text: Edit personal booking link {id} with the new details.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduling_link/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a personal scheduling link
      effect: destructive
      questions:
      - Can I remove one of my own booking links that I no longer use?
      - What's the way to delete a user scheduling link I created manually?
      instructions:
      - text: Delete user scheduling link {id}.
        slots:
          id: path.id
      - text: Remove my personal booking link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shared_scheduling_link/'].get
  update:
    x-apievangelist-phrasing:
      intent: List team shared scheduling links
      effect: read
      questions:
      - Which shared scheduling links exist for my team?
      - Can I see all organization-wide booking links?
      instructions:
      - text: List all shared scheduling links.
      - text: Show the team's shared booking links.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shared_scheduling_link/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shared scheduling link
      effect: write
      questions:
      - How do I create a booking link that the whole team can use?
      - Can I set up a shared scheduling link for my organization?
      instructions:
      - text: Create a new shared scheduling link for the team.
      - text: Add an organization-wide shared booking link.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shared_scheduling_link/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch one shared scheduling link
      effect: read
      questions:
      - What does a particular shared scheduling link point to?
      - Can I retrieve a team booking link by its id?
      instructions:
      - text: Fetch shared scheduling link {id}.
        slots:
          id: path.id
      - text: Show details for the team booking link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shared_scheduling_link/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a shared scheduling link
      effect: write
      questions:
      - Can I rename or change a shared team booking link?
      - Is it possible to edit a shared scheduling link after it's created?
      instructions:
      - text: Update shared scheduling link {id}.
        slots:
          id: path.id
      - text: Edit the team booking link {id} with the new settings.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shared_scheduling_link/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shared scheduling link
      effect: destructive
      questions:
      - Can I remove a shared booking link the team no longer uses?
      - What happens when I delete a shared scheduling link?
      instructions:
      - text: Delete shared scheduling link {id}.
        slots:
          id: path.id
      - text: Remove the team booking link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shared_scheduling_link_association/'].post
  update:
    x-apievangelist-phrasing:
      intent: Map a shared link to a user link or URL
      effect: write
      questions:
      - Can I point a shared scheduling link at a specific user's booking link?
      - Is it possible to map a shared scheduling link to a plain URL instead?
      instructions:
      - text: Map a shared scheduling link to a user's personal scheduling link.
      - text: Associate the shared booking link with a custom URL.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shared_scheduling_link_association/unmap/'].post
  update:
    x-apievangelist-phrasing:
      intent: Unmap a shared scheduling link
      effect: destructive
      questions:
      - Can I undo the mapping between a shared scheduling link and a user's link?
      - What's the way to detach a shared booking link from where it currently points?
      instructions:
      - text: Unmap the shared scheduling link from its user link or URL.
      - text: Remove the association on a shared booking link.
      method: generated
      generated: '2026-09-26'