# 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 Accounts API
  version: 1.0.0
extends: openapi/getresponse-accounts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 14
- target: $.paths['/accounts/blocklists'].get
  update:
    x-apievangelist-phrasing:
      intent: View the account blocklist
      effect: read
      questions:
      - Which email addresses and domains are on my account-wide blocklist?
      - Can I check whether a specific mask is already blocked on my GetResponse account?
      instructions:
      - text: Show me every mask on my account blocklist.
      - text: Check whether {mask} is on my account blocklist.
        slots:
          mask: query.query[mask]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/blocklists'].post
  update:
    x-apievangelist-phrasing:
      intent: Update the account blocklist
      effect: write
      questions:
      - Can I add email addresses or domains to my account-wide blocklist in bulk?
      - What happens to the existing entries when I send a new set of blocklist masks?
      instructions:
      - text: Replace my account blocklist masks with {masks}.
        slots:
          masks: requestBody.masks
      - text: Add {masks} to the account blocklist using flags {additionalFlags}.
        slots:
          masks: requestBody.masks
          additionalFlags: query.additionalFlags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get account profile details
      effect: read
      questions:
      - What company name, email and time zone are set on my account?
      - Where can I see the owner details registered for my email marketing account?
      instructions:
      - text: Show my account profile information.
      - text: Get only the {fields} fields of my account profile.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Update account profile details
      effect: write
      questions:
      - Can I change the company name and phone number on my account through the API?
      - Is it possible to switch my account's time zone or time format?
      instructions:
      - text: Change my account's company name to {companyName}.
        slots:
          companyName: requestBody.companyName
      - text: Update the account owner to {firstName} {lastName} with phone {phone}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          phone: requestBody.phone
      - text: Set my account address to {street}, {city} {zipCode}.
        slots:
          street: requestBody.street
          city: requestBody.city
          zipCode: requestBody.zipCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/billing'].get
  update:
    x-apievangelist-phrasing:
      intent: Get account billing information
      effect: read
      questions:
      - What plan am I on and what are my billing details?
      - Can I see my subscription and payment information via the API?
      instructions:
      - text: Show my account billing information.
      - text: Get the {fields} fields from my billing details.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/timezones'].get
  update:
    x-apievangelist-phrasing:
      intent: List available time zones
      effect: read
      questions:
      - Which time zone values can I choose from for my account?
      - Is there a list of supported time zones in my account's language?
      instructions:
      - text: List all the time zones I can pick from.
      - text: Show the time zone names available in my account language.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/callbacks'].get
  update:
    x-apievangelist-phrasing:
      intent: View the callbacks configuration
      effect: read
      questions:
      - Are callbacks turned on for my account, and which URL do they hit?
      - Which contact actions currently trigger a callback notification?
      instructions:
      - text: Show my current callbacks configuration.
      - text: Tell me which URL and actions my callbacks are set up for.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/callbacks'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable or change callbacks
      effect: write
      questions:
      - How do I get notified at my own URL when contacts subscribe or unsubscribe?
      - Can I choose which actions send a callback to my server?
      instructions:
      - text: Enable callbacks to {url}.
        slots:
          url: requestBody.url
      - text: Send callbacks to {url} for the actions {actions}.
        slots:
          url: requestBody.url
          actions: requestBody.actions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/callbacks'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disable callbacks
      effect: destructive
      questions:
      - How can I stop my account from sending callback notifications?
      - Can I switch off callbacks completely instead of changing the URL?
      instructions:
      - text: Turn off callbacks for my account.
      - text: Disable all callback notifications.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/industries'].get
  update:
    x-apievangelist-phrasing:
      intent: List industry tags
      effect: read
      questions:
      - Which industry tags can I assign to my account?
      - What industry categories are available in my account's language?
      instructions:
      - text: List the available industry tags.
      - text: Show page {page} of industry tags, {perPage} per page.
        slots:
          page: query.page
          perPage: query.perPage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/login-history'].get
  update:
    x-apievangelist-phrasing:
      intent: View account login history
      effect: read
      questions:
      - Who has logged into my account recently and when?
      - Can I audit past sign-ins to my email marketing account?
      instructions:
      - text: Show my account's login history.
      - text: Get page {page} of my login history with {perPage} entries.
        slots:
          page: query.page
          perPage: query.perPage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/badge'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the GetResponse badge status
      effect: read
      questions:
      - Is the GetResponse badge currently shown in my emails?
      - What is the current status of my account's promotional badge?
      instructions:
      - text: Tell me whether my GetResponse badge is on or off.
      - text: Check whether the GetResponse badge appears in my emails.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/badge'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn the GetResponse badge on or off
      effect: write
      questions:
      - Can I remove the GetResponse badge from my messages?
      - How do I switch the badge back on and pick its style?
      instructions:
      - text: Set my GetResponse badge status to {status}.
        slots:
          status: requestBody.status
      - text: Turn the badge {status} using the {type} style.
        slots:
          status: requestBody.status
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/sending-limits'].get
  update:
    x-apievangelist-phrasing:
      intent: Check account sending limits
      effect: read
      questions:
      - How many emails am I still allowed to send on my account?
      - What are the send limits for my current plan?
      instructions:
      - text: Show my account's sending limits.
      - text: Tell me how many more emails my plan lets me send.
      method: generated
      generated: '2026-10-02'