# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Marketing Campaigns Sms Campaigns API
  version: 1.0.0
extends: openapi/brevo-sms-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: 10
- target: $.paths['/smsCampaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List SMS campaigns
      effect: read
      questions:
      - Which SMS campaigns have I created in Brevo?
      - Can I list only the SMS campaigns that were sent in a given month?
      instructions:
      - text: List my SMS campaigns with status {status}.
        slots:
          status: query.status
      - text: List SMS campaigns from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smsCampaigns'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an SMS campaign
      effect: write
      questions:
      - How do I set up a bulk text message campaign?
      - What's the length limit on an SMS campaign's sender name?
      - Can I schedule an SMS campaign when I create it?
      instructions:
      - text: Create an SMS campaign {name} from sender {sender} with text {content}.
        slots:
          name: requestBody.name
          sender: requestBody.sender
          content: requestBody.content
      - text: Create SMS campaign {name} from {sender} saying {content}, scheduled for {scheduledAt}.
        slots:
          name: requestBody.name
          sender: requestBody.sender
          content: requestBody.content
          scheduledAt: requestBody.scheduledAt
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smsCampaigns/{campaignId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SMS campaign
      effect: read
      questions:
      - How many texts in a specific SMS campaign were delivered?
      - What content and recipient lists does one SMS campaign use?
      instructions:
      - text: Get SMS campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      - text: Show delivery stats and recipients for SMS campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smsCampaigns/{campaignId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an SMS campaign
      effect: write
      questions:
      - Can I change the text of an SMS campaign before it sends?
      - How do I reschedule an existing SMS campaign?
      instructions:
      - text: Change the text of SMS campaign {campaignId} to {content}.
        slots:
          campaignId: path.campaignId
          content: requestBody.content
      - text: Reschedule SMS campaign {campaignId} to {scheduledAt}.
        slots:
          campaignId: path.campaignId
          scheduledAt: requestBody.scheduledAt
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smsCampaigns/{campaignId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SMS campaign
      effect: destructive
      questions:
      - Can I delete an SMS campaign that has already been scheduled?
      - How do I remove an unsent SMS campaign draft?
      instructions:
      - text: Delete SMS campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      - text: Remove the unsent SMS campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smsCampaigns/{campaignId}/sendNow'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an SMS campaign immediately
      effect: write
      questions:
      - How do I send an SMS campaign right away?
      - Will sending an SMS campaign now fail if I'm out of SMS credits?
      instructions:
      - text: Send SMS campaign {campaignId} now.
        slots:
          campaignId: path.campaignId
      - text: Launch text campaign {campaignId} to its recipients immediately.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smsCampaigns/{campaignId}/status'].put
  update:
    x-apievangelist-phrasing:
      intent: Suspend, archive or replicate an SMS campaign
      effect: write
      questions:
      - Can I pause a scheduled SMS campaign?
      - How do I archive or copy an old text message campaign?
      instructions:
      - text: Set SMS campaign {campaignId} status to {status}.
        slots:
          campaignId: path.campaignId
          status: requestBody.status
      - text: Suspend text campaign {campaignId} with status {status}.
        slots:
          campaignId: path.campaignId
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smsCampaigns/{campaignId}/sendTest'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test SMS of a campaign
      effect: write
      questions:
      - Can I text myself a preview of an SMS campaign first?
      - Which phone numbers am I allowed to send an SMS test to?
      instructions:
      - text: Send a test of SMS campaign {campaignId} to {phoneNumber}.
        slots:
          campaignId: path.campaignId
          phoneNumber: requestBody.phoneNumber
      - text: Text a preview of campaign {campaignId} to my number {phoneNumber}.
        slots:
          campaignId: path.campaignId
          phoneNumber: requestBody.phoneNumber
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smsCampaigns/{campaignId}/exportRecipients'].post
  update:
    x-apievangelist-phrasing:
      intent: Export an SMS campaign's recipients
      effect: write
      questions:
      - Can I export who received or unsubscribed from an SMS campaign?
      - How will I know when an SMS recipient export is finished?
      instructions:
      - text: Export the {recipientsType} recipients of SMS campaign {campaignId}.
        slots:
          recipientsType: requestBody.recipientsType
          campaignId: path.campaignId
      - text: Export {recipientsType} from SMS campaign {campaignId} and call {notifyURL} when ready.
        slots:
          recipientsType: requestBody.recipientsType
          campaignId: path.campaignId
          notifyURL: requestBody.notifyURL
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smsCampaigns/{campaignId}/sendReport'].post
  update:
    x-apievangelist-phrasing:
      intent: Email an SMS campaign's report
      effect: write
      questions:
      - Can I email a PDF report of an SMS campaign's results?
      - Which SMS campaigns can have their report emailed?
      instructions:
      - text: Email the report of SMS campaign {campaignId} to {email}.
        slots:
          campaignId: path.campaignId
          email: requestBody.email
      - text: Send SMS campaign {campaignId} results to {email} in {language}.
        slots:
          campaignId: path.campaignId
          email: requestBody.email
          language: requestBody.language
      method: generated
      generated: '2026-10-01'