Brevo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Accounts and Settings User API

7 actions 7 updates phrasing extends openapi/brevo-user-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['/organization/invited/users'].get
$.paths['/organization/user/{email}/permissions'].get
$.paths['/organization/user/invitation/revoke/{email}'].put
$.paths['/organization/user/invitation/{action}/{email}'].put
$.paths['/organization/user/invitation/send'].post
$.paths['/organization/user/update/permissions'].post

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 Accounts and Settings User API
  version: 1.0.0
extends: openapi/brevo-user-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['/organization/invited/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users in the organization
      effect: read
      questions:
      - Who has access to my Brevo organization, including pending invites?
      - Which of my invited users haven't accepted yet?
      instructions:
      - text: List all users in my organization.
      - text: Show active and pending users using API key {api_key}.
        slots:
          api_key: header.api-key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organization/user/{email}/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a user's feature permissions
      effect: read
      questions:
      - What features can a specific teammate access in our organization?
      - Does a given user have permission to send email campaigns?
      instructions:
      - text: Check the permissions of user {email}.
        slots:
          email: path.email
      - text: Show the feature-level access granted to {email}.
        slots:
          email: path.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organization/user/invitation/revoke/{email}'].put
  update:
    x-apievangelist-phrasing:
      intent: Revoke a user's access
      effect: destructive
      questions:
      - How do I remove a teammate's access to the organization?
      - Can I revoke all permissions for an invited user?
      instructions:
      - text: Revoke all permissions for user {email}.
        slots:
          email: path.email
      - text: Remove {email}'s access to the organization.
        slots:
          email: path.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organization/user/invitation/{action}/{email}'].put
  update:
    x-apievangelist-phrasing:
      intent: Resend or cancel a user invitation
      effect: write
      questions:
      - Can I resend an organization invite that expired?
      - How do I cancel a pending invitation to a teammate?
      instructions:
      - text: Perform {action} on the pending organization invitation for {email}.
        slots:
          action: path.action
          email: path.email
      - text: Cancel or resend the teammate invite to {email} with action {action}.
        slots:
          email: path.email
          action: path.action
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organization/user/invitation/send'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a user to the organization
      effect: write
      questions:
      - How do I invite a colleague to our Brevo organization?
      - Can I limit an invited user to only certain features like Deals or Automations?
      instructions:
      - text: Invite {email} to the organization with all-features access {all_features_access}.
        slots:
          email: requestBody.email
          all_features_access: requestBody.all_features_access
      - text: Invite {email} with privileges {privileges} and all-features access {all_features_access}.
        slots:
          email: requestBody.email
          privileges: requestBody.privileges
          all_features_access: requestBody.all_features_access
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organization/user/update/permissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an existing user's permissions
      effect: write
      questions:
      - How do I change what an existing teammate can do?
      - Can I give a current user access to every feature?
      instructions:
      - text: Update permissions for existing user {email} to {privileges}, all-features access {all_features_access}.
        slots:
          email: requestBody.email
          privileges: requestBody.privileges
          all_features_access: requestBody.all_features_access
      - text: Grant current teammate {email} full access by setting all-features access {all_features_access} and privileges {privileges}.
        slots:
          email: requestBody.email
          all_features_access: requestBody.all_features_access
          privileges: requestBody.privileges
      method: generated
      generated: '2026-09-26'