Act! CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for act.web.api Supplemental Files API

17 actions 17 updates phrasing extends openapi/act-supplementalfiles-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Act! CRM's API. It is a proposal applied on top of the contract, not a document Act! CRM publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 17 · first 16 shown; the file carries all of them

$.info

$.paths['/api/attachments/activities/{id}'].get

$.paths['/api/attachments/activities/{id}'].post

$.paths['/api/attachments/activities/{id}'].delete

$.paths['/api/attachments/documents/{id}'].get

$.paths['/api/attachments/documents/{id}'].post

$.paths['/api/attachments/documents/{id}'].delete

$.paths['/api/attachments/history/{id}'].get

$.paths['/api/attachments/history/{id}'].post

$.paths['/api/attachments/history/{id}'].delete

$.paths['/api/attachments/notes/{id}'].get

$.paths['/api/attachments/notes/{id}'].post

$.paths['/api/attachments/notes/{id}'].delete

$.paths['/api/attachments/{id}/upload-status'].get

$.paths['/api/layouts/{filename}'].get

$.paths['/api/layouts'].get

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 act.web.api Supplemental Files API
  version: 1.0.0
extends: openapi/act-supplementalfiles-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 16
- target: $.paths['/api/attachments/activities/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an activity's attachment
      effect: read
      questions:
      - How do I download the file attached to an activity?
      - Can I fetch the attachment on a task or meeting?
      instructions:
      - text: Get the attachment for activity {id}.
        slots:
          id: path.id
      - text: Download activity {id}'s attached file.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/attachments/activities/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a file to an activity
      effect: write
      questions:
      - How do I attach a file to an activity?
      - Can I upload an attachment to a scheduled meeting or call?
      instructions:
      - text: Attach a file to activity {id}.
        slots:
          id: path.id
      - text: Upload an attachment for activity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/attachments/activities/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an activity's attachment
      effect: destructive
      questions:
      - How do I remove an attachment from an activity?
      - Can I delete the file attached to a meeting without deleting the meeting?
      instructions:
      - text: Delete the attachment on activity {id}.
        slots:
          id: path.id
      - text: Remove activity {id}'s attachment.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/attachments/documents/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document's attachment
      effect: read
      questions:
      - Where do I retrieve the file behind a document record?
      - Can I download the attachment stored on a document?
      instructions:
      - text: Get the attachment for document {id}.
        slots:
          id: path.id
      - text: Download the file attached to document {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/attachments/documents/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a file to a document
      effect: write
      questions:
      - How do I upload a file to a document record?
      - Can I add an attachment to an existing document?
      instructions:
      - text: Attach a file to document {id}.
        slots:
          id: path.id
      - text: Upload an attachment for document {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/attachments/documents/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a document's attachment
      effect: destructive
      questions:
      - How do I remove the attachment from a document?
      - Can I delete a document's file but keep the document record?
      instructions:
      - text: Delete the attachment on document {id}.
        slots:
          id: path.id
      - text: Remove document {id}'s attached file.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/attachments/history/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a history entry's attachment
      effect: read
      questions:
      - Can I download the file attached to a history entry?
      - Where do I fetch an attachment saved with a logged history item?
      instructions:
      - text: Get the attachment for history {id}.
        slots:
          id: path.id
      - text: Download the file on history entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/attachments/history/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a file to a history entry
      effect: write
      questions:
      - How do I attach a file to a history record?
      - Can I add an attachment to a history item I already logged?
      instructions:
      - text: Attach a file to history {id}.
        slots:
          id: path.id
      - text: Upload an attachment for history entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/attachments/history/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a history entry's attachment
      effect: destructive
      questions:
      - How do I remove the attachment from a history entry?
      - Can I delete a history item's file without deleting the history?
      instructions:
      - text: Delete the attachment on history {id}.
        slots:
          id: path.id
      - text: Remove history entry {id}'s attached file.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/attachments/notes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a note's attachment
      effect: read
      questions:
      - Can I download the file attached to a note?
      - Where do I get an attachment stored on a note?
      instructions:
      - text: Get the attachment for note {id}.
        slots:
          id: path.id
      - text: Download the file on note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/attachments/notes/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a file to a note
      effect: write
      questions:
      - How do I attach a file to a note?
      - Can I upload a document onto an existing note?
      instructions:
      - text: Attach a file to note {id}.
        slots:
          id: path.id
      - text: Upload an attachment for note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/attachments/notes/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a note's attachment
      effect: destructive
      questions:
      - How do I remove the attachment from a note?
      - Can I delete a note's file but keep the note text?
      instructions:
      - text: Delete the attachment on note {id}.
        slots:
          id: path.id
      - text: Remove note {id}'s attached file.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/attachments/{id}/upload-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an attachment's upload status
      effect: read
      questions:
      - Is a chunked attachment upload still in progress?
      - When is it safe to edit or delete an attachment after uploading it?
      instructions:
      - text: Check the upload status of {id}.
        slots:
          id: path.id
      - text: Get the attachment upload progress for {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/layouts/{filename}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a layout definition
      effect: read
      questions:
      - Where do I fetch one layout definition by its file name?
      - Can I read a specific screen layout file?
      instructions:
      - text: Get layout {filename}.
        slots:
          filename: path.filename
      - text: Show the layout definition in {filename}.
        slots:
          filename: path.filename
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/layouts'].get
  update:
    x-apievangelist-phrasing:
      intent: List layout definitions
      effect: read
      questions:
      - Which layout definitions are available?
      - Can I list all the screen layouts in the database?
      instructions:
      - text: List layout definitions.
      - text: Show all available layouts.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a template
      effect: write
      questions:
      - How do I upload a template?
      - Can I add a new template file through the API?
      instructions:
      - text: Upload a template.
      - text: Add a new template file.
      method: generated
      generated: '2026-10-01'