Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Integration Links API

6 actions 6 updates phrasing extends openapi/close-integration-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 6

$.info

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

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

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

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

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

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 Integration Links API
  version: 1.0.0
extends: openapi/close-integration-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: 5
- target: $.paths['/integration_link/'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration links
      effect: read
      questions:
      - Which integration links have we added to records?
      - What custom links show up on our leads and contacts?
      instructions:
      - text: List our integration links.
      - text: Show all integration links in the organization.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/integration_link/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an integration link
      effect: write
      questions:
      - How do I add a link to an external tool on every lead?
      - Can an integration link use a URL template?
      instructions:
      - text: Create an integration link {name} of type {type} pointing to {url}.
        slots:
          name: requestBody.name
          type: requestBody.type
          url: requestBody.url
      - text: Add a {type} link called {name} with URL {url}.
        slots:
          name: requestBody.name
          type: requestBody.type
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/integration_link/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration link
      effect: read
      questions:
      - How do I look up one integration link's URL?
      - Where can I see the details of a single integration link?
      instructions:
      - text: Show integration link {id}.
        slots:
          id: path.id
      - text: Fetch the URL template of integration link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/integration_link/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an integration link
      effect: write
      questions:
      - Can I change where an integration link points?
      - How do I rename an existing integration link?
      instructions:
      - text: Change the URL of integration link {id} to {url}.
        slots:
          id: path.id
          url: requestBody.url
      - text: Rename integration link {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/integration_link/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration link
      effect: destructive
      questions:
      - Can I remove an integration link we no longer need?
      - What's the way to delete an integration link?
      instructions:
      - text: Delete integration link {id}.
        slots:
          id: path.id
      - text: Remove integration link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'