Brevo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brevo Conversations Messages API

5 actions 5 updates phrasing extends openapi/brevo-messages-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/conversations/messages'].post

$.paths['/conversations/messages/{messageId}'].get

$.paths['/conversations/messages/{messageId}'].put

$.paths['/conversations/messages/{messageId}'].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 Brevo Conversations Messages API
  version: 1.0.0
extends: openapi/brevo-messages-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: 4
- target: $.paths['/conversations/messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a chat message as an agent
      effect: write
      questions:
      - How do I reply to a website visitor in live chat from code?
      - Can I send a chat message under a specific agent's name?
      instructions:
      - text: Send {text} to visitor {visitorId}.
        slots:
          text: requestBody.text
          visitorId: requestBody.visitorId
      - text: Reply to visitor {visitorId} with {text} as agent {agentId}.
        slots:
          visitorId: requestBody.visitorId
          text: requestBody.text
          agentId: requestBody.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/messages/{messageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a chat message
      effect: read
      questions:
      - Who sent a particular chat message and when?
      - Can I retrieve one chat message by its ID?
      instructions:
      - text: Show chat message {messageId}.
        slots:
          messageId: path.messageId
      - text: Get the text and sender of message {messageId}.
        slots:
          messageId: path.messageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/messages/{messageId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an agent's chat message
      effect: write
      questions:
      - Can I fix a typo in a chat message I already sent?
      - Which chat messages are editable?
      instructions:
      - text: Change the text of message {messageId} to {text}.
        slots:
          messageId: path.messageId
          text: requestBody.text
      - text: Edit agent message {messageId} to read {text}.
        slots:
          messageId: path.messageId
          text: requestBody.text
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/messages/{messageId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a chat message
      effect: destructive
      questions:
      - Can I remove a message from a chat conversation?
      - Is deleting a chat message permanent?
      instructions:
      - text: Delete chat message {messageId}.
        slots:
          messageId: path.messageId
      - text: Permanently remove message {messageId} from the conversation.
        slots:
          messageId: path.messageId
      method: generated
      generated: '2026-09-26'