AWeber · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AWeber Custom Fields API

6 actions 6 updates phrasing extends openapi/aweber-custom-fields-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for AWeber's API. It is a proposal applied on top of the contract, not a document AWeber publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/accounts/{accountId}/lists/{listId}/custom_fields'].get

$.paths['/accounts/{accountId}/lists/{listId}/custom_fields'].post

$.paths['/accounts/{accountId}/lists/{listId}/custom_fields/{customFieldId}'].get

$.paths['/accounts/{accountId}/lists/{listId}/custom_fields/{customFieldId}'].delete

$.paths['/accounts/{accountId}/lists/{listId}/custom_fields/{customFieldId}'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for AWeber Custom Fields API
  version: 1.0.0
extends: openapi/aweber-custom-fields-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: 5
- target: $.paths['/accounts/{accountId}/lists/{listId}/custom_fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List a list's custom fields
      effect: read
      questions:
      - What custom fields are set up on my subscriber list?
      - Can I page through custom fields if a list has a lot of them?
      instructions:
      - text: List the custom fields on list {listId} in account {accountId}.
        slots:
          listId: path.listId
          accountId: path.accountId
      - text: Show {size} custom fields for list {listId}, account {accountId}, starting at {start}.
        slots:
          size: query.ws.size
          listId: path.listId
          accountId: path.accountId
          start: query.ws.start
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/custom_fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a custom field to a list
      effect: write
      questions:
      - How do I add a new custom field, like a birthday, to my list?
      - Can I create extra subscriber fields beyond name and email?
      instructions:
      - text: Add a custom field named {name} to list {listId} in account {accountId}.
        slots:
          name: requestBody.name
          listId: path.listId
          accountId: path.accountId
      - text: Create a new {name} field for subscribers on list {listId}, account {accountId}, using operation {op}.
        slots:
          name: requestBody.name
          listId: path.listId
          accountId: path.accountId
          op: requestBody.ws.op
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/custom_fields/{customFieldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom field
      effect: read
      questions:
      - What are the settings of one particular custom field?
      - Can subscribers edit a given custom field themselves?
      instructions:
      - text: Show custom field {customFieldId} on list {listId} in account {accountId}.
        slots:
          customFieldId: path.customFieldId
          listId: path.listId
          accountId: path.accountId
      - text: Fetch the details of custom field {customFieldId} from list {listId}, account {accountId}.
        slots:
          customFieldId: path.customFieldId
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/custom_fields/{customFieldId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom field
      effect: destructive
      questions:
      - How do I remove a custom field I no longer use?
      - What could break if I delete a custom field from my list?
      instructions:
      - text: Delete custom field {customFieldId} from list {listId} in account {accountId}.
        slots:
          customFieldId: path.customFieldId
          listId: path.listId
          accountId: path.accountId
      - text: Remove the {customFieldId} field entirely from list {listId}, account {accountId}.
        slots:
          customFieldId: path.customFieldId
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/custom_fields/{customFieldId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or update a custom field
      effect: write
      questions:
      - Can I rename an existing custom field?
      - Is it possible to let subscribers update a custom field on their own?
      instructions:
      - text: Rename custom field {customFieldId} on list {listId} in account {accountId} to {name}.
        slots:
          customFieldId: path.customFieldId
          listId: path.listId
          accountId: path.accountId
          name: requestBody.name
      - text: Set subscriber-editable to {is_subscriber_updateable} on field {customFieldId}, list {listId}, account {accountId}.
        slots:
          is_subscriber_updateable: requestBody.is_subscriber_updateable
          customFieldId: path.customFieldId
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'