# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Contact Management Consent Groups API
  version: 1.0.0
extends: openapi/brevo-consent-groups-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/contacts/consent-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List consent groups
      effect: read
      questions:
      - Which consent groups have I set up for my contacts?
      - Can I filter consent groups by their signup mode?
      instructions:
      - text: List my consent groups.
      - text: Find consent groups named {name} with signup mode {signupMode}.
        slots:
          name: query.name
          signupMode: query.signupMode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contacts/consent-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a consent group
      effect: write
      questions:
      - How do I create a consent group to track marketing opt-ins?
      - Can a new consent group be tied to specific contact lists?
      instructions:
      - text: Create a consent group {name} with signup mode {signupMode}.
        slots:
          name: requestBody.name
          signupMode: requestBody.signupMode
      - text: Create consent group {name}, signup mode {signupMode}, covering lists {listIds}.
        slots:
          name: requestBody.name
          signupMode: requestBody.signupMode
          listIds: requestBody.listIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contacts/consent-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a consent group
      effect: read
      questions:
      - What signup mode and description does one consent group have?
      - Can I look up a single consent group by ID?
      instructions:
      - text: Get consent group {id}.
        slots:
          id: path.id
      - text: Show the settings of consent group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contacts/consent-groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a consent group
      effect: write
      questions:
      - Can I rename a consent group or change its description?
      - How do I switch a consent group's signup mode?
      instructions:
      - text: Rename consent group {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the signup mode of consent group {id} to {signupMode}.
        slots:
          id: path.id
          signupMode: requestBody.signupMode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contacts/consent-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a consent group
      effect: destructive
      questions:
      - What happens to contacts when I delete their consent group?
      - How do I remove a consent group I no longer need?
      instructions:
      - text: Delete consent group {id}.
        slots:
          id: path.id
      - text: Remove consent group {id} from all contacts.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'