# 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 Custom Fields API
  version: 1.0.0
extends: openapi/getresponse-custom-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['/custom-fields/{customFieldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom field definition
      effect: read
      questions:
      - What type and allowed values does one of my custom fields have?
      - Can I look up a single custom field by ID?
      instructions:
      - text: Get custom field {field}.
        slots:
          field: path.customFieldId
      - text: Show the definition of custom field {field}.
        slots:
          field: path.customFieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-fields/{customFieldId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a custom field's values or visibility
      effect: write
      questions:
      - Can I change the allowed values of an existing custom field?
      - Is it possible to hide a custom field from subscribers?
      instructions:
      - text: Set custom field {field} values to {values}.
        slots:
          field: path.customFieldId
          values: requestBody.values
      - text: Set hidden to {hidden} on custom field {field}.
        slots:
          hidden: requestBody.hidden
          field: path.customFieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-fields/{customFieldId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom field
      effect: destructive
      questions:
      - How do I get rid of a custom field I no longer use?
      - Is removing a custom field definition permanent?
      instructions:
      - text: Delete custom field {field}.
        slots:
          field: path.customFieldId
      - text: Remove the custom field definition {field}.
        slots:
          field: path.customFieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom fields
      effect: read
      questions:
      - Which custom fields are defined in my account?
      - Can I search custom fields by name?
      instructions:
      - text: List all my custom fields.
      - text: Find custom fields named {name}.
        slots:
          name: query.query[name]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom field
      effect: write
      questions:
      - How do I add a new custom field like birthday or company to contacts?
      - What field types can a new custom field have?
      instructions:
      - text: Create a custom field {name} of type {type}.
        slots:
          name: requestBody.name
          type: requestBody.type
      - text: Add a custom field {name} with values {values}.
        slots:
          name: requestBody.name
          values: requestBody.values
      method: generated
      generated: '2026-09-26'