# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for GetResponse APIv3 Newsletters API version: 1.0.0 extends: openapi/getresponse-newsletters-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: 10 - target: $.paths['/newsletters/{newsletterId}'].get update: x-apievangelist-phrasing: intent: Get a newsletter effect: read questions: - What subject, content and send settings does a particular newsletter have? - Can I look up one newsletter by its ID? instructions: - text: Show newsletter {newsletterId}. slots: newsletterId: path.newsletterId - text: Get the {fields} fields of newsletter {newsletterId}. slots: fields: query.fields newsletterId: path.newsletterId method: generated generated: '2026-09-26' - target: $.paths['/newsletters/{newsletterId}'].delete update: x-apievangelist-phrasing: intent: Delete a newsletter effect: destructive questions: - Can I permanently remove a newsletter I no longer need? - What's the way to delete an old newsletter from my account? instructions: - text: Delete newsletter {newsletterId}. slots: newsletterId: path.newsletterId - text: Permanently remove newsletter {newsletterId} from my account. slots: newsletterId: path.newsletterId method: generated generated: '2026-09-26' - target: $.paths['/newsletters/{newsletterId}/activities'].get update: x-apievangelist-phrasing: intent: List a newsletter's contact activities effect: read questions: - Which contacts opened or clicked a specific newsletter? - Can I filter a newsletter's activity log by activity type and date? instructions: - text: List the activities recorded for newsletter {newsletterId}. slots: newsletterId: path.newsletterId - text: Show {activity} activities on newsletter {newsletterId} since {from}. slots: activity: query.query[activity] newsletterId: path.newsletterId from: query.query[createdOn][from] method: generated generated: '2026-09-26' - target: $.paths['/newsletters/{newsletterId}/cancel'].post update: x-apievangelist-phrasing: intent: Cancel sending a newsletter effect: destructive questions: - Can I stop a newsletter that's already queued to go out? - What happens to a newsletter after I cancel its sending? instructions: - text: Cancel sending newsletter {newsletterId} and turn it back into a draft. slots: newsletterId: path.newsletterId - text: Stop the scheduled send of newsletter {newsletterId}. slots: newsletterId: path.newsletterId method: generated generated: '2026-09-26' - target: $.paths['/newsletters/{newsletterId}/statistics'].get update: x-apievangelist-phrasing: intent: Get statistics for one newsletter effect: read questions: - How did one specific newsletter perform on opens and clicks? - Can I break a single newsletter's stats down by hour, day or month? instructions: - text: Show statistics for newsletter {newsletterId}. slots: newsletterId: path.newsletterId - text: Get newsletter {newsletterId} stats grouped by {groupBy}. slots: newsletterId: path.newsletterId groupBy: query.query[groupBy] method: generated generated: '2026-09-26' - target: $.paths['/newsletters/{newsletterId}/thumbnail'].get update: x-apievangelist-phrasing: intent: Get a newsletter thumbnail image effect: read questions: - Is there a preview image of what a newsletter looks like? - Which thumbnail sizes can I request for a newsletter? instructions: - text: Get the thumbnail for newsletter {newsletterId}. slots: newsletterId: path.newsletterId - text: Fetch a {size} thumbnail of newsletter {newsletterId}. slots: size: query.size newsletterId: path.newsletterId method: generated generated: '2026-09-26' - target: $.paths['/newsletters'].get update: x-apievangelist-phrasing: intent: List newsletters effect: read questions: - Which newsletters have I sent or scheduled recently? - Can I filter my newsletters by subject, status or list? - How do I find newsletters sent within a certain date range? instructions: - text: List all my newsletters. - text: Show newsletters with status {status} in list {campaignId}. slots: status: query.query[status] campaignId: query.query[campaignId] - text: Find newsletters whose subject contains {subject}. slots: subject: query.query[subject] method: generated generated: '2026-09-26' - target: $.paths['/newsletters'].post update: x-apievangelist-phrasing: intent: Create and queue a newsletter effect: write questions: - How do I create a new newsletter and send it to a list? - Is there a daily cap on how many newsletters I can create through the API? instructions: - text: Create a newsletter with subject {subject} for list {campaign} from {fromField}. slots: subject: requestBody.subject campaign: requestBody.campaign fromField: requestBody.fromField - text: Send a newsletter named {name} with content {content} using send settings {sendSettings}. slots: name: requestBody.name content: requestBody.content sendSettings: requestBody.sendSettings method: generated generated: '2026-09-26' - target: $.paths['/newsletters/send-draft'].post update: x-apievangelist-phrasing: intent: Send a newsletter draft effect: write questions: - Can I send a newsletter I already saved as a draft? - What do I need to provide to send out an existing draft? instructions: - text: Send draft {messageId} with send settings {sendSettings}. slots: messageId: requestBody.messageId sendSettings: requestBody.sendSettings - text: Send out my saved draft {messageId} now using {sendSettings}. slots: messageId: requestBody.messageId sendSettings: requestBody.sendSettings method: generated generated: '2026-09-26' - target: $.paths['/newsletters/statistics'].get update: x-apievangelist-phrasing: intent: Get combined newsletter statistics effect: read questions: - What are the total opens and clicks across several newsletters? - Can I get aggregated newsletter stats for a whole list? instructions: - text: Show combined statistics for newsletters {newsletterId}. slots: newsletterId: query.query[newsletterId] - text: Get total newsletter stats for list {campaignId} grouped by {groupBy}. slots: campaignId: query.query[campaignId] groupBy: query.query[groupBy] method: generated generated: '2026-09-26'