SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sendpulse Chats API

4 actions 4 updates phrasing extends openapi/sendpulse-chats-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 4

$.info

$.paths['/chats'].get

$.paths['/chats/messages'].get

$.paths['/chats/react'].put

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 Sendpulse Chats API
  version: 1.0.0
extends: openapi/sendpulse-chats-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: 3
- target: $.paths['/chats'].get
  update:
    x-apievangelist-phrasing:
      intent: List chatbot conversations
      effect: read
      questions:
      - Which contacts have chatted with my bot recently?
      - Can I see the last message from each conversation for a bot?
      instructions:
      - text: List the chats for bot {bot_id}.
        slots:
          bot_id: query.bot_id
      - text: Show {size} conversations of bot {bot_id}, skipping {skip}.
        slots:
          size: query.size
          bot_id: query.bot_id
          skip: query.skip
      method: generated
      generated: '2026-10-01'
- target: $.paths['/chats/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the messages in a contact's chat
      effect: read
      questions:
      - What has a specific contact said to my chatbot?
      - Can I read the full message history with one subscriber?
      instructions:
      - text: Show the messages with contact {contact_id}.
        slots:
          contact_id: query.contact_id
      - text: Get the last {size} messages exchanged with contact {contact_id}.
        slots:
          size: query.size
          contact_id: query.contact_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/chats/react'].put
  update:
    x-apievangelist-phrasing:
      intent: React to a contact's chat message
      effect: write
      questions:
      - Can I react with an emoji to a message a contact sent?
      - Is it possible to like a subscriber's message?
      instructions:
      - text: React to message {message_id} with {reaction}.
        slots:
          message_id: requestBody.message_id
          reaction: requestBody.reaction
      - text: Put a {reaction} reaction on chat message {message_id}.
        slots:
          reaction: requestBody.reaction
          message_id: requestBody.message_id
      method: generated
      generated: '2026-10-01'