# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Conversations API
  version: 1.0.0
extends: openapi/brevo-conversations-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: 10
- target: $.paths['/conversations/messages/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a conversation message
      effect: read
      questions:
      - What did a specific chat message in Brevo Conversations say?
      - Can I fetch one agent or visitor message by its ID?
      instructions:
      - text: Get conversation message {id}.
        slots:
          id: path.id
      - text: Show me the chat message with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/messages/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a message an agent sent
      effect: write
      questions:
      - Can I fix a typo in a chat reply an agent already sent?
      - Which messages am I allowed to edit in a conversation?
      instructions:
      - text: Change the text of agent message {id} to {text}.
        slots:
          id: path.id
          text: requestBody.text
      - text: Edit the agent's chat reply {id} so it reads {text}.
        slots:
          id: path.id
          text: requestBody.text
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/messages/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a message an agent sent
      effect: destructive
      questions:
      - How do I delete a chat reply an agent posted by mistake?
      - Can visitor messages be deleted or only agent ones?
      instructions:
      - text: Delete agent message {id}.
        slots:
          id: path.id
      - text: Remove the agent's chat reply {id} from the conversation.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Reply to a visitor as an agent
      effect: write
      questions:
      - How do I post a chat reply to a website visitor as one of my agents?
      - Can I reply as an agent by email and name instead of agent ID?
      instructions:
      - text: Reply to visitor {visitorId} as agent {agentId} saying {text}.
        slots:
          visitorId: requestBody.visitorId
          agentId: requestBody.agentId
          text: requestBody.text
      - text: Send {text} to visitor {visitorId} as agent {agentName} ({agentEmail}) from {receivedFrom}.
        slots:
          text: requestBody.text
          visitorId: requestBody.visitorId
          agentName: requestBody.agentName
          agentEmail: requestBody.agentEmail
          receivedFrom: requestBody.receivedFrom
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/pushedMessages/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an automated chat message
      effect: read
      questions:
      - What did an automated pushed message to a visitor contain?
      - Can I look up one proactive message by its ID?
      instructions:
      - text: Get automated message {id}.
        slots:
          id: path.id
      - text: Show the pushed chat message {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/pushedMessages/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an automated chat message
      effect: write
      questions:
      - Can I change the text of an automated message after it was pushed?
      - How do I correct a pushed order-status message?
      instructions:
      - text: Update automated message {id} to say {text}.
        slots:
          id: path.id
          text: requestBody.text
      - text: Rewrite the pushed message {id} as {text}.
        slots:
          id: path.id
          text: requestBody.text
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/pushedMessages/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an automated chat message
      effect: destructive
      questions:
      - How do I remove a pushed message from a visitor's chat?
      - Can I delete an automated message I sent by mistake?
      instructions:
      - text: Delete automated message {id}.
        slots:
          id: path.id
      - text: Remove pushed message {id} from the conversation.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/pushedMessages'].post
  update:
    x-apievangelist-phrasing:
      intent: Push an automated message to a visitor
      effect: write
      questions:
      - How do I push an order status update into a visitor's chat window?
      - Can I send a proactive message on behalf of an agent group?
      instructions:
      - text: Push automated message {text} to visitor {visitorId}.
        slots:
          text: requestBody.text
          visitorId: requestBody.visitorId
      - text: Push {text} to visitor {visitorId} on behalf of agent group {groupId}.
        slots:
          text: requestBody.text
          visitorId: requestBody.visitorId
          groupId: requestBody.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/agentOnlinePing'].post
  update:
    x-apievangelist-phrasing:
      intent: Keep an agent shown as online
      effect: write
      questions:
      - How do I keep an agent showing as online in the chat widget?
      - How often should I ping to keep an agent's status online?
      instructions:
      - text: Mark agent {agentId} online for the next few minutes.
        slots:
          agentId: requestBody.agentId
      - text: Ping online status for agent {agentName} at {agentEmail}.
        slots:
          agentName: requestBody.agentName
          agentEmail: requestBody.agentEmail
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/visitorGroup'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign a visitor to an agent group
      effect: write
      questions:
      - How do I route a chat visitor to a specific team of agents?
      - Can I take a visitor out of their current agent group?
      instructions:
      - text: Assign the visitor to agent group {groupId}.
        slots:
          groupId: requestBody.groupId
      - text: Move the visitor into group {groupId}.
        slots:
          groupId: requestBody.groupId
      method: generated
      generated: '2026-09-26'