# 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 Search Contacts API
  version: 1.0.0
extends: openapi/getresponse-search-contacts-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: 8
- target: $.paths['/search-contacts/{searchContactId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a saved segment definition
      effect: read
      questions:
      - What conditions make up one of my saved contact segments?
      - Can I view the filter rules behind a saved search?
      instructions:
      - text: Show the conditions of saved segment {searchContactId}.
        slots:
          searchContactId: path.searchContactId
      - text: Get the filter definition of saved search {searchContactId}.
        slots:
          searchContactId: path.searchContactId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/search-contacts/{searchContactId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a saved segment
      effect: write
      questions:
      - Can I change the conditions of a segment I already saved?
      - Is it possible to rename a saved contact search?
      instructions:
      - text: Update saved segment {searchContactId} with sections {section} joined by {sectionLogicOperator}.
        slots:
          searchContactId: path.searchContactId
          section: requestBody.section
          sectionLogicOperator: requestBody.sectionLogicOperator
      - text: Rename saved segment {searchContactId} to {name}, keeping sections {section} and operator {sectionLogicOperator}.
        slots:
          searchContactId: path.searchContactId
          name: requestBody.name
          section: requestBody.section
          sectionLogicOperator: requestBody.sectionLogicOperator
      method: generated
      generated: '2026-09-26'
- target: $.paths['/search-contacts/{searchContactId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved segment
      effect: destructive
      questions:
      - How do I remove a saved contact segment I no longer use?
      - Does deleting a saved search remove the filter itself rather than the contacts?
      instructions:
      - text: Delete saved segment {searchContactId}.
        slots:
          searchContactId: path.searchContactId
      - text: Remove the saved contact search {searchContactId}.
        slots:
          searchContactId: path.searchContactId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/search-contacts/{searchContactId}/contacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List contacts in a saved segment
      effect: read
      questions:
      - Which contacts currently match one of my saved segments?
      - Can I sort the members of a saved search by email or signup date?
      instructions:
      - text: List the contacts matching saved segment {searchContactId}.
        slots:
          searchContactId: path.searchContactId
      - text: Show page {page} of contacts in segment {searchContactId}.
        slots:
          page: query.page
          searchContactId: path.searchContactId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/search-contacts/{searchContactId}/custom-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Set custom fields for a whole segment
      effect: write
      questions:
      - Can I update a custom field for every contact in a segment at once?
      - Will bulk-setting custom fields on a segment overwrite values that aren't in my request?
      instructions:
      - text: Set custom field values {customFieldValues} on everyone in segment {searchContactId}.
        slots:
          customFieldValues: requestBody.customFieldValues
          searchContactId: path.searchContactId
      - text: Bulk-update custom fields to {customFieldValues} for every contact matching saved search {searchContactId}.
        slots:
          customFieldValues: requestBody.customFieldValues
          searchContactId: path.searchContactId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/search-contacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved segments
      effect: read
      questions:
      - Which saved contact segments (custom filters) do I have?
      - Can I find a saved search by name or creation date?
      instructions:
      - text: List all my saved segments.
      - text: Find saved segments named {name}.
        slots:
          name: query.query[name]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/search-contacts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a saved segment
      effect: write
      questions:
      - How do I save a new contact segment for later reuse?
      - Can I combine several condition sections into one saved search?
      instructions:
      - text: Save a segment named {name} with sections {section} joined by {sectionLogicOperator}.
        slots:
          name: requestBody.name
          section: requestBody.section
          sectionLogicOperator: requestBody.sectionLogicOperator
      - text: Create a saved contact search of {subscribersType} contacts using sections {section} and operator {sectionLogicOperator}.
        slots:
          subscribersType: requestBody.subscribersType
          section: requestBody.section
          sectionLogicOperator: requestBody.sectionLogicOperator
      method: generated
      generated: '2026-09-26'
- target: $.paths['/search-contacts/contacts'].post
  update:
    x-apievangelist-phrasing:
      intent: Find contacts matching ad-hoc conditions
      effect: read
      questions:
      - Can I search contacts by conditions without saving a segment first?
      - Which contacts match a one-off filter I define on the fly?
      instructions:
      - text: Find contacts matching sections {section} joined by {sectionLogicOperator}, without saving it.
        slots:
          section: requestBody.section
          sectionLogicOperator: requestBody.sectionLogicOperator
      - text: Run a one-off contact search with sections {section} and operator {sectionLogicOperator}, sorted by email {email}.
        slots:
          section: requestBody.section
          sectionLogicOperator: requestBody.sectionLogicOperator
          email: query.sort[email]
      method: generated
      generated: '2026-09-26'