Brevo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sales CRM Notes API

6 actions 6 updates phrasing extends openapi/brevo-notes-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 6

$.info

$.paths['/crm/notes'].get

$.paths['/crm/notes'].post

$.paths['/crm/notes/{id}'].get

$.paths['/crm/notes/{id}'].delete

$.paths['/crm/notes/{id}'].patch

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 Sales CRM Notes API
  version: 1.0.0
extends: openapi/brevo-notes-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: 5
- target: $.paths['/crm/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List CRM notes
      effect: read
      questions:
      - What notes have been logged against a company or deal in the CRM?
      - Can I list notes written within a date range?
      instructions:
      - text: List notes for {entity} with IDs {entityIds}.
        slots:
          entity: query.entity
          entityIds: query.entityIds
      - text: List CRM notes created between {dateFrom} and {dateTo}.
        slots:
          dateFrom: query.dateFrom
          dateTo: query.dateTo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a CRM note
      effect: write
      questions:
      - How do I log a note after a call with a customer?
      - Can one note be attached to a contact and a deal at the same time?
      instructions:
      - text: Add a note saying {text} to contacts {contactIds}.
        slots:
          text: requestBody.text
          contactIds: requestBody.contactIds
      - text: Create a note {text} linked to deals {dealIds} and companies {companyIds}.
        slots:
          text: requestBody.text
          dealIds: requestBody.dealIds
          companyIds: requestBody.companyIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/notes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a CRM note
      effect: read
      questions:
      - Who wrote a given note and what does it say?
      - Which records is a particular note linked to?
      instructions:
      - text: Get note {id}.
        slots:
          id: path.id
      - text: Show the text, author and links of note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/notes/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a CRM note
      effect: destructive
      questions:
      - How do I delete a note logged by mistake?
      - Does deleting a note unlink it from its contacts and deals?
      instructions:
      - text: Delete note {id}.
        slots:
          id: path.id
      - text: Permanently remove CRM note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/notes/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a CRM note
      effect: write
      questions:
      - Can I edit the text of a note I already saved?
      - How do I re-link an existing note to different deals?
      instructions:
      - text: Change note {id} to read {text}.
        slots:
          id: path.id
          text: requestBody.text
      - text: Update note {id} with text {text} and link it to deals {dealIds}.
        slots:
          id: path.id
          text: requestBody.text
          dealIds: requestBody.dealIds
      method: generated
      generated: '2026-09-26'