# 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 Predefined Fields API
  version: 1.0.0
extends: openapi/getresponse-predefined-fields-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: 5
- target: $.paths['/predefined-fields/{predefinedFieldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a predefined field
      effect: read
      questions:
      - What value does one of my predefined fields hold?
      - Can I look up a predefined merge field by ID?
      instructions:
      - text: Get predefined field {field}.
        slots:
          field: path.predefinedFieldId
      - text: Show the details of predefined field {field}.
        slots:
          field: path.predefinedFieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/predefined-fields/{predefinedFieldId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a predefined field's value
      effect: write
      questions:
      - Can I change the text a predefined field inserts into my messages?
      - Where do I update the value of an existing predefined field?
      instructions:
      - text: Set predefined field {field} to {value}.
        slots:
          field: path.predefinedFieldId
          value: requestBody.value
      - text: Change the value of predefined field {field} to {value}.
        slots:
          field: path.predefinedFieldId
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/predefined-fields/{predefinedFieldId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a predefined field
      effect: destructive
      questions:
      - How do I remove a predefined field I don't use anymore?
      - Is deleting a predefined field permanent?
      instructions:
      - text: Delete predefined field {field}.
        slots:
          field: path.predefinedFieldId
      - text: Remove predefined field {field} from my account.
        slots:
          field: path.predefinedFieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/predefined-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List predefined fields
      effect: read
      questions:
      - What predefined fields exist for my lists?
      - Can I list predefined fields for just one list?
      instructions:
      - text: List my predefined fields.
      - text: List predefined fields on list {campaign}.
        slots:
          campaign: query.query[campaignId]
      - text: Find predefined fields named {name}.
        slots:
          name: query.query[name]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/predefined-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a predefined field
      effect: write
      questions:
      - Can I create a reusable value to insert into emails for a list?
      - What does a new predefined field need, like a name and value?
      instructions:
      - text: Create predefined field {name} with value {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      - text: Add predefined field {name} to list {campaign}.
        slots:
          name: requestBody.name
          campaign: requestBody.campaign
      method: generated
      generated: '2026-09-26'