Brevo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sales CRM Tasks API

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

$.info
$.paths['/crm/tasktypes'].get
$.paths['/crm/tasks'].get
$.paths['/crm/tasks'].post
$.paths['/crm/tasks/{id}'].get
$.paths['/crm/tasks/{id}'].delete
$.paths['/crm/tasks/{id}'].patch

OpenAPI Overlay

Raw ↑
# 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 Tasks API
  version: 1.0.0
extends: openapi/brevo-tasks-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: 6
- target: $.paths['/crm/tasktypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List task types
      effect: read
      questions:
      - What kinds of CRM tasks can I create, like calls or meetings?
      - Where do I find the task type ID needed to create a task?
      instructions:
      - text: List all task types.
      - text: Show the task types for the account with API key {api_key}.
        slots:
          api_key: header.api-key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List and filter tasks
      effect: read
      questions:
      - Which CRM tasks are assigned to a specific person?
      - Can I list only tasks that are still open for a deal?
      - What tasks are due within a date range?
      instructions:
      - text: List all my CRM tasks.
      - text: Show tasks with status {status} assigned to {assignTo}.
        slots:
          status: query.filter[status]
          assignTo: query.filter[assignTo]
      - text: List tasks linked to deal {deal}.
        slots:
          deal: query.filter[deals]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a task
      effect: write
      questions:
      - How do I create a follow-up task in the CRM?
      - Can I link a new task to a contact or deal and set a reminder?
      instructions:
      - text: Create task {name} of type {taskTypeId} due {date}.
        slots:
          name: requestBody.name
          taskTypeId: requestBody.taskTypeId
          date: requestBody.date
      - text: Create task {name}, type {taskTypeId}, due {date}, linked to deals {dealsIds}.
        slots:
          name: requestBody.name
          taskTypeId: requestBody.taskTypeId
          date: requestBody.date
          dealsIds: requestBody.dealsIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/tasks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a task
      effect: read
      questions:
      - What are the details and linked records of a specific task?
      - Who is assigned to one particular task?
      instructions:
      - text: Show task {id}.
        slots:
          id: path.id
      - text: Get the due date and notes of task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/tasks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a task
      effect: destructive
      questions:
      - Does deleting a task cancel its reminders?
      - Who is allowed to delete a CRM task?
      instructions:
      - text: Delete task {id}.
        slots:
          id: path.id
      - text: Permanently remove task {id} and its reminder.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/tasks/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a task
      effect: write
      questions:
      - Can I mark a task as done?
      - Is it possible to reassign or reschedule an existing task?
      instructions:
      - text: Mark task {id} as done.
        slots:
          id: path.id
      - text: Reschedule task {id} to {date}.
        slots:
          id: path.id
          date: requestBody.date
      - text: Reassign task {id} to user {assignToId}.
        slots:
          id: path.id
          assignToId: requestBody.assignToId
      method: generated
      generated: '2026-09-26'