# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Brevo WhatsApp WhatsApp Campaigns API
  version: 1.0.0
extends: openapi/brevo-whatsapp-campaigns-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: 9
- target: $.paths['/whatsappCampaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List WhatsApp campaigns
      effect: read
      questions:
      - What WhatsApp campaigns exist in my account?
      - Can I list WhatsApp campaigns from a specific date range?
      instructions:
      - text: List my WhatsApp campaigns.
      - text: Show WhatsApp campaigns between {startDate} and {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/whatsappCampaigns'].post
  update:
    x-apievangelist-phrasing:
      intent: Create and send a WhatsApp campaign
      effect: write
      questions:
      - How do I send a WhatsApp marketing campaign with a template?
      - Can I schedule a WhatsApp campaign for later?
      instructions:
      - text: Create WhatsApp campaign {name} with template {templateId} to {recipients}.
        slots:
          name: requestBody.name
          templateId: requestBody.templateId
          recipients: requestBody.recipients
      - text: Schedule WhatsApp campaign {name} using template {templateId} at {scheduledAt} for {recipients}.
        slots:
          name: requestBody.name
          templateId: requestBody.templateId
          scheduledAt: requestBody.scheduledAt
          recipients: requestBody.recipients
      method: generated
      generated: '2026-09-26'
- target: $.paths['/whatsappCampaigns/{campaignId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a WhatsApp campaign
      effect: read
      questions:
      - What are the delivery stats of one WhatsApp campaign?
      - Which template and recipients does a specific WhatsApp campaign use?
      instructions:
      - text: Show WhatsApp campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      - text: Get delivery statistics for WhatsApp campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/whatsappCampaigns/{campaignId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a draft WhatsApp campaign
      effect: write
      questions:
      - Can I change the template or schedule of a WhatsApp campaign?
      - Which WhatsApp campaigns are still editable?
      instructions:
      - text: Change the template of WhatsApp campaign {campaignId} to {templateId}.
        slots:
          campaignId: path.campaignId
          templateId: requestBody.templateId
      - text: Reschedule draft WhatsApp campaign {campaignId} to {scheduledAt}.
        slots:
          campaignId: path.campaignId
          scheduledAt: requestBody.scheduledAt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/whatsappCampaigns/{campaignId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a WhatsApp campaign
      effect: destructive
      questions:
      - Can I permanently delete a WhatsApp campaign?
      - Is removing a WhatsApp campaign reversible?
      instructions:
      - text: Delete WhatsApp campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      - text: Permanently remove WhatsApp campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/whatsappCampaigns/template-list'].get
  update:
    x-apievangelist-phrasing:
      intent: List WhatsApp templates
      effect: read
      questions:
      - Which WhatsApp templates have I created and are they approved yet?
      - Can I list only the WhatsApp templates made for Automation or Conversations?
      instructions:
      - text: List my WhatsApp templates from source {source}.
        slots:
          source: query.source
      - text: Show WhatsApp templates created between {startDate} and {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/whatsappCampaigns/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get WhatsApp account configuration
      effect: read
      questions:
      - Is my WhatsApp Business account connected and what is its status?
      - Can I check my WhatsApp API account information before sending campaigns?
      instructions:
      - text: Show my WhatsApp account configuration.
      - text: Get WhatsApp API account info for the account with API key {api_key}.
        slots:
          api_key: header.api-key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/whatsappCampaigns/template'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a WhatsApp template
      effect: write
      questions:
      - How do I make a new WhatsApp message template for campaigns?
      - Can I add an image header to a WhatsApp template?
      - What is the character limit on a WhatsApp template body?
      instructions:
      - text: Create WhatsApp template {name} in {language}, category {category}, with body {bodyText}.
        slots:
          name: requestBody.name
          language: requestBody.language
          category: requestBody.category
          bodyText: requestBody.bodyText
      - text: Create {category} WhatsApp template {name} in {language} with body {bodyText} and header media {mediaUrl}.
        slots:
          category: requestBody.category
          name: requestBody.name
          language: requestBody.language
          bodyText: requestBody.bodyText
          mediaUrl: requestBody.mediaUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/whatsappCampaigns/template/approval/{templateId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a WhatsApp template for approval
      effect: write
      questions:
      - How do I get a WhatsApp template approved so I can use it?
      - Can I submit a draft WhatsApp template for review from the API?
      instructions:
      - text: Submit WhatsApp template {templateId} for approval.
        slots:
          templateId: path.templateId
      - text: Send template {templateId} off to be reviewed for WhatsApp use.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-10-01'