Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Activities.form Submissions API

4 actions 4 updates phrasing extends openapi/close-activities-form-submissions-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 4

$.info

$.paths['/activity/form_submission/'].get

$.paths['/activity/form_submission/{id}/'].get

$.paths['/activity/form_submission/{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 Activities.form Submissions API
  version: 1.0.0
extends: openapi/close-activities-form-submissions-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['/activity/form_submission/'].get
  update:
    x-apievangelist-phrasing:
      intent: List form submission activities
      effect: read
      questions:
      - Which leads submitted a particular form?
      - Can I filter form submissions by several forms at once?
      instructions:
      - text: List form submissions for form {form_id}.
        slots:
          form_id: query.form_id
      - text: Show form submissions on lead {lead_id}.
        slots:
          lead_id: query.lead_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/form_submission/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single form submission
      effect: read
      questions:
      - What answers were given in one form submission?
      - How do I look up a form submission by ID?
      instructions:
      - text: Show form submission {id}.
        slots:
          id: path.id
      - text: Fetch the answers in form submission {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/form_submission/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a form submission
      effect: destructive
      questions:
      - Can I remove a spam form submission from a lead?
      - What's the way to delete a form submission record?
      instructions:
      - text: Delete form submission {id}.
        slots:
          id: path.id
      - text: Remove the spam form submission {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'