# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Sendpulse Campaigns API
  version: 1.0.0
extends: openapi/sendpulse-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: 24
- target: $.paths['/campaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List email campaigns and their status
      effect: read
      questions:
      - Where can I see the history and status of all my SendPulse email campaigns?
      - Can I list only the email campaigns that are still scheduled to go out?
      - Which email campaigns have I sent, sorted newest first?
      instructions:
      - text: List all my email campaigns with their delivery status.
      - text: Show my email campaigns with status {status}, {limit} at a time.
        slots:
          status: query.status
          limit: query.limit
      - text: List the email campaigns that are planned but not yet sent.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns'].post
  update:
    x-apievangelist-phrasing:
      intent: Create and send or schedule an email campaign
      effect: write
      questions:
      - How do I send an email campaign to one of my mailing lists?
      - Can I schedule an email newsletter to go out at a specific date and time?
      - Is it possible to send an email campaign built from a saved template to a segment?
      instructions:
      - text: Send an email campaign with subject {subject} from {sender_email} to mailing list {list_id} using template {template_id}.
        slots:
          subject: requestBody.subject
          sender_email: requestBody.sender_email
          list_id: requestBody.list_id
          template_id: requestBody.template_id
      - text: Schedule an email campaign named {name} from {sender_name} with subject {subject} for {send_date}.
        slots:
          name: requestBody.name
          sender_name: requestBody.sender_name
          subject: requestBody.subject
          send_date: requestBody.send_date
      - text: Send a test email of the campaign with subject {subject} from {sender_email}.
        slots:
          subject: requestBody.subject
          sender_email: requestBody.sender_email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details and stats for one email campaign
      effect: read
      questions:
      - What are the open and delivery stats for a specific email campaign?
      - Can I look up the details of one email campaign by its ID?
      instructions:
      - text: Show the details and stats of email campaign {id}.
        slots:
          id: path.id
      - text: How did email campaign {id} perform; pull its numbers
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending email campaign
      effect: destructive
      questions:
      - Can I stop an email campaign that is already pending or processing?
      - How do I cancel a scheduled email newsletter before it goes out?
      instructions:
      - text: Cancel email campaign {id}.
        slots:
          id: path.id
      - text: Stop the pending email send for campaign {id} right now.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a scheduled email campaign's name or subject
      effect: write
      questions:
      - Can I change the subject line of an email campaign that is still scheduled?
      - Is it possible to rename a pending email campaign?
      instructions:
      - text: Change the subject of scheduled email campaign {id} to {subject}.
        slots:
          id: path.id
          subject: requestBody.subject
      - text: Rename pending email campaign {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns/{id}/countries'].get
  update:
    x-apievangelist-phrasing:
      intent: Break down email campaign opens by country
      effect: read
      questions:
      - Which countries opened my email campaign the most?
      - Can I see a geographic breakdown of opens for a campaign?
      instructions:
      - text: Show the opens by country for email campaign {id}.
        slots:
          id: path.id
      - text: Break down where readers of campaign {id} were located.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns/{id}/referrals'].get
  update:
    x-apievangelist-phrasing:
      intent: Break down link clicks in an email campaign
      effect: read
      questions:
      - Which links in my email campaign got clicked the most?
      - Can I get click counts per link for a sent campaign?
      instructions:
      - text: Show the link click breakdown for email campaign {id}.
        slots:
          id: path.id
      - text: List the referral links clicked in campaign {id} with their counts.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addressbooks/{id}/campaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List the campaigns sent to a mailing list
      effect: read
      questions:
      - What email campaigns have been sent to a particular mailing list?
      - Can I see every campaign that targeted one address book?
      instructions:
      - text: List the campaigns that targeted mailing list {id}.
        slots:
          id: path.id
      - text: Show the first {limit} campaigns sent to address book {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns/send'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a text broadcast to a chatbot's subscribers
      effect: write
      questions:
      - Can I broadcast a text message to everyone subscribed to my chatbot?
      - Is it possible to schedule a chatbot campaign for later instead of sending now?
      - Can I filter which bot subscribers receive a message campaign?
      instructions:
      - text: Send a text campaign titled {title} to all subscribers of bot {bot_id} with messages {messages}.
        slots:
          title: requestBody.title
          bot_id: requestBody.bot_id
          messages: requestBody.messages
      - text: Schedule chatbot broadcast {title} for bot {bot_id} at {send_at} with messages {messages}.
        slots:
          title: requestBody.title
          bot_id: requestBody.bot_id
          send_at: requestBody.send_at
          messages: requestBody.messages
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sms/campaigns'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an SMS campaign to a mailing list
      effect: write
      questions:
      - How do I send a text message campaign to the phone numbers in a mailing list?
      - Can I schedule an SMS blast to an address book for a later date?
      - Is there a way to emulate an SMS send to a list without actually sending?
      instructions:
      - text: Send SMS {body} from sender {sender} to mailing list {addressBookId}.
        slots:
          body: requestBody.body
          sender: requestBody.sender
          addressBookId: requestBody.addressBookId
      - text: Schedule an SMS campaign to address book {addressBookId} from {sender} for {date} saying {body}.
        slots:
          addressBookId: requestBody.addressBookId
          sender: requestBody.sender
          date: requestBody.date
          body: requestBody.body
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sms/campaigns'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SMS campaign
      effect: destructive
      questions:
      - Can I delete an SMS campaign I no longer need?
      - What happens if I remove an SMS campaign record by its ID?
      instructions:
      - text: Delete SMS campaign {id}.
        slots:
          id: requestBody.id
      - text: Remove the SMS campaign with ID {id} from my account.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sms/send'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an SMS to a list of phone numbers
      effect: write
      questions:
      - Can I text a handful of phone numbers directly without a mailing list?
      - How do I send an SMS to specific numbers at a scheduled time?
      instructions:
      - text: Text {phones} from sender {sender} with message {body}.
        slots:
          phones: requestBody.phones
          sender: requestBody.sender
          body: requestBody.body
      - text: Send SMS {body} from {sender} to numbers {phones} on {date}.
        slots:
          body: requestBody.body
          sender: requestBody.sender
          phones: requestBody.phones
          date: requestBody.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sms/campaigns/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List SMS campaigns within a date range
      effect: read
      questions:
      - Which SMS campaigns did I send last month?
      - Can I list SMS campaigns between two dates?
      instructions:
      - text: List my SMS campaigns from {dateFrom} to {dateTo}.
        slots:
          dateFrom: query.dateFrom
          dateTo: query.dateTo
      - text: Show all my recent SMS campaigns.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sms/campaigns/info/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one SMS campaign
      effect: read
      questions:
      - What is the status and delivery info of one SMS campaign?
      - Can I check the results of a specific text message campaign?
      instructions:
      - text: Show the details of SMS campaign {id}.
        slots:
          id: path.id
      - text: Get delivery info for text campaign {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sms/campaigns/cancel/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel an SMS campaign before sending starts
      effect: destructive
      questions:
      - Can I cancel an SMS campaign before it starts sending?
      - Is it too late to stop a scheduled text blast once sending has begun?
      instructions:
      - text: Cancel SMS campaign {id} before it goes out.
        slots:
          id: path.id
      - text: Stop scheduled text campaign {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sms/campaigns/cost'].get
  update:
    x-apievangelist-phrasing:
      intent: Estimate the cost of an SMS campaign
      effect: read
      questions:
      - How much will it cost to send an SMS to my mailing list?
      - Can I estimate SMS pricing for a list of phone numbers before sending?
      instructions:
      - text: Calculate the cost of sending {body} from {sender} to mailing list {addressBookId}.
        slots:
          body: query.body
          sender: query.sender
          addressBookId: query.addressBookId
      - text: Estimate what it costs to text {phones} the message {body} from {sender}.
        slots:
          phones: query.phones
          body: query.body
          sender: query.sender
      method: generated
      generated: '2026-10-01'
- target: $.paths['/viber'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Viber campaign
      effect: write
      questions:
      - How do I send a Viber message campaign to my subscribers?
      - Can I set how long a Viber message stays live before it expires?
      - Is it possible to send a Viber campaign to a mailing list on a set date?
      instructions:
      - text: Send a Viber campaign from sender {sender_id} to mailing list {address_book} on {send_date} with message type {message_type} and live time {message_live_time}.
        slots:
          sender_id: requestBody.sender_id
          address_book: requestBody.address_book
          send_date: requestBody.send_date
          message_type: requestBody.message_type
          message_live_time: requestBody.message_live_time
      - text: Create Viber campaign {task_name} with message {message} from {sender_id}, type {message_type}, live {message_live_time}, sending {send_date}.
        slots:
          task_name: requestBody.task_name
          message: requestBody.message
          sender_id: requestBody.sender_id
          message_type: requestBody.message_type
          message_live_time: requestBody.message_live_time
          send_date: requestBody.send_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/viber/task'].get
  update:
    x-apievangelist-phrasing:
      intent: List Viber campaigns
      effect: read
      questions:
      - Which Viber campaigns have I created?
      - Can I page through my Viber message campaigns?
      instructions:
      - text: List my Viber campaigns.
      - text: Show {limit} Viber campaigns starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/viber/task/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statistics for a Viber campaign
      effect: read
      questions:
      - How did my Viber campaign perform?
      - What are the delivery and read stats for one Viber campaign?
      instructions:
      - text: Show statistics for Viber campaign {id}.
        slots:
          id: path.id
      - text: Get delivery numbers for Viber task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/viber/task/{id}/recipients'].get
  update:
    x-apievangelist-phrasing:
      intent: List recipients of a Viber campaign
      effect: read
      questions:
      - Who received my Viber campaign?
      - Can I get the list of phone numbers a Viber campaign went to?
      instructions:
      - text: List the recipients of Viber campaign {id}.
        slots:
          id: path.id
      - text: Show who Viber task {id} was sent to.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/push/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List sent web push campaigns
      effect: read
      questions:
      - Which web push notifications have I sent from my website?
      - Can I list push campaigns sent between two dates for one site?
      instructions:
      - text: List my sent web push campaigns.
      - text: Show web push campaigns for website {website_id} from {from} to {to}.
        slots:
          website_id: query.website_id
          from: query.from
          to: query.to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/push/tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a web push notification campaign
      effect: write
      questions:
      - How do I send a browser push notification to my website subscribers?
      - Can I target web push notifications by browser, language or region?
      - Is it possible to add buttons and an image to a push notification?
      instructions:
      - text: Send a web push titled {title} saying {body} to website {website_id} with a lifetime of {ttl} seconds.
        slots:
          title: requestBody.title
          body: requestBody.body
          website_id: requestBody.website_id
          ttl: requestBody.ttl
      - text: Schedule push notification {title} for website {website_id} on {send_date} linking to {link}, body {body}, ttl {ttl}.
        slots:
          title: requestBody.title
          website_id: requestBody.website_id
          send_date: requestBody.send_date
          link: requestBody.link
          body: requestBody.body
          ttl: requestBody.ttl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/push/tasks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statistics for a web push campaign
      effect: read
      questions:
      - How many people clicked my web push notification?
      - What are the delivery stats for one sent push campaign?
      instructions:
      - text: Show stats for web push campaign {id}.
        slots:
          id: path.id
      - text: Get click and delivery numbers for push task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns/sendTemplate'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a template message to a chatbot's subscribers
      effect: write
      questions:
      - Can I broadcast a message template with an image or file to all my bot subscribers?
      - Is it possible to schedule a template-based chatbot campaign?
      instructions:
      - text: Send template {template} as campaign {title} to all subscribers of bot {bot_id}.
        slots:
          template: requestBody.template
          title: requestBody.title
          bot_id: requestBody.bot_id
      - text: Schedule template broadcast {title} for bot {bot_id} at {send_at} using template {template}.
        slots:
          title: requestBody.title
          bot_id: requestBody.bot_id
          send_at: requestBody.send_at
          template: requestBody.template
      method: generated
      generated: '2026-10-01'