Brevo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brevo Conversations Automated Messages API

5 actions 5 updates phrasing extends openapi/brevo-automated-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/pushedMessages'].post

$.paths['/conversations/pushedMessages/{pushedMessageId}'].get

$.paths['/conversations/pushedMessages/{pushedMessageId}'].put

$.paths['/conversations/pushedMessages/{pushedMessageId}'].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 Automated Messages API
  version: 1.0.0
extends: openapi/brevo-automated-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/pushedMessages'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an automated message to a visitor
      effect: write
      questions:
      - How do I send a proactive welcome message to a website visitor?
      - Can a scripted bot message be sent on behalf of an agent group?
      instructions:
      - text: Send automated message {text} to visitor {visitorId}.
        slots:
          text: requestBody.text
          visitorId: requestBody.visitorId
      - text: Send {text} to visitor {visitorId} as agent {agentId}.
        slots:
          text: requestBody.text
          visitorId: requestBody.visitorId
          agentId: requestBody.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/pushedMessages/{pushedMessageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an automated message
      effect: read
      questions:
      - What was in a particular automated message?
      - Can I retrieve a pushed message by its identifier?
      instructions:
      - text: Get automated message {pushedMessageId}.
        slots:
          pushedMessageId: path.pushedMessageId
      - text: Show pushed message {pushedMessageId}.
        slots:
          pushedMessageId: path.pushedMessageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/pushedMessages/{pushedMessageId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an automated message
      effect: write
      questions:
      - Can I change the wording of an automated message already sent?
      - How do I edit a proactive message's content?
      instructions:
      - text: Change automated message {pushedMessageId} to {text}.
        slots:
          pushedMessageId: path.pushedMessageId
          text: requestBody.text
      - text: Update the content of pushed message {pushedMessageId} to read {text}.
        slots:
          pushedMessageId: path.pushedMessageId
          text: requestBody.text
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/pushedMessages/{pushedMessageId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an automated message
      effect: destructive
      questions:
      - How do I permanently delete an automated message?
      - Can I remove a pushed message from the chat history?
      instructions:
      - text: Delete automated message {pushedMessageId}.
        slots:
          pushedMessageId: path.pushedMessageId
      - text: Permanently remove pushed message {pushedMessageId}.
        slots:
          pushedMessageId: path.pushedMessageId
      method: generated
      generated: '2026-09-26'