SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse CRM Public Attachments API

5 actions 5 updates phrasing extends openapi/sendpulse-attachments-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for SendPulse's API. It is a proposal applied on top of the contract, not a document SendPulse publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/attachments'].post
$.paths['/attachments/batch'].post
$.paths['/attachments/{attachmentId}'].put
$.paths['/attachments/{attachmentId}'].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 SendPulse CRM Public Attachments API
  version: 1.0.0
extends: openapi/sendpulse-attachments-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: 4
- target: $.paths['/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach an uploaded file to a CRM record
      effect: write
      questions:
      - How do I attach a file from the file manager to a deal or contact?
      - Do I need to upload a file before I can attach it?
      instructions:
      - text: Attach the file at {link} to {entityType} {entityId}.
        slots:
          link: requestBody.link
          entityType: requestBody.entityType
          entityId: requestBody.entityId
      - text: Attach uploaded file {link} to record {entityId}.
        slots:
          link: requestBody.link
          entityId: requestBody.entityId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attachments/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach several uploaded files in one request
      effect: write
      questions:
      - Can I attach multiple files to CRM records in one go?
      - Is there a bulk way to create file attachments?
      instructions:
      - text: 'Attach these files in bulk: {attachments}.'
        slots:
          attachments: requestBody.attachments
      - text: Create a batch of attachments {attachments}.
        slots:
          attachments: requestBody.attachments
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attachments/{attachmentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace the file on an existing attachment
      effect: write
      questions:
      - Can I point an existing attachment at a different file?
      - What's the way to swap the file on an attachment?
      instructions:
      - text: Change attachment {attachmentId} to the file at {link}.
        slots:
          attachmentId: path.attachmentId
          link: requestBody.link
      - text: Update attachment {attachmentId} with a new file link {link}.
        slots:
          attachmentId: path.attachmentId
          link: requestBody.link
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attachments/{attachmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a file attachment
      effect: destructive
      questions:
      - Can I remove a file attached to a deal or contact?
      - What's the way to delete an attachment?
      instructions:
      - text: Delete attachment {attachmentId}.
        slots:
          attachmentId: path.attachmentId
      - text: Remove the attached file {attachmentId}.
        slots:
          attachmentId: path.attachmentId
      method: generated
      generated: '2026-10-01'