API Evangelist conversational phrasing for ActiveCampaign API v3 Groups API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ActiveCampaign API v3 Groups API
  version: 1.0.0
extends: openapi/activecampaign-groups-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: 12
- target: $.paths['/groupMembers'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field group memberships
      effect: read
      questions:
      - Which custom fields are placed in which field groups?
      - Can I list every custom field group membership in my account?
      instructions:
      - text: List all custom field group memberships.
      - text: Show which custom fields sit in each field group.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groupMembers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a custom field to a field group
      effect: write
      questions:
      - How do I put a custom field into a field group?
      - Can I organize my custom fields into groups through the API?
      instructions:
      - text: 'Add a custom field to a field group: {groupMember}.'
        slots:
          groupMember: requestBody.groupMember
      - text: Place the custom field I name into the Billing field group.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groupMembers/{groupID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a custom field group membership
      effect: read
      questions:
      - How do I look up one custom field group entry by its ID?
      - What does a single field group membership contain?
      instructions:
      - text: Get custom field group {groupID}.
        slots:
          groupID: path.groupID
      - text: Show field group membership {groupID}.
        slots:
          groupID: path.groupID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groupMembers/{groupID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom field group membership
      effect: destructive
      questions:
      - How do I take a custom field out of its field group?
      - Can I delete a field group membership by ID?
      instructions:
      - text: Delete custom field group membership {groupID}.
        slots:
          groupID: path.groupID
      - text: Remove field group entry {groupID}.
        slots:
          groupID: path.groupID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groupDefinitions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom field group
      effect: write
      questions:
      - How do I create a new custom field group with a name and display order?
      - Can I choose the group type when creating a field group?
      instructions:
      - text: Create a custom field group named {label}.
        slots:
          label: query.groupDefinition.label
      - text: Create field group {label} shown at position {ordernum} with type {groupType}.
        slots:
          label: query.groupDefinition.label
          ordernum: query.groupDefinition.ordernum
          groupType: query.groupDefinition.groupType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groupMembers/{groupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Move or reorder a field in a field group
      effect: write
      questions:
      - How do I change the order of a custom field inside its field group?
      - Can I move a custom field to a different field group?
      instructions:
      - text: Update field group {groupId} to hold custom field {rel_id} at order {ordernum}.
        slots:
          groupId: path.groupId
          rel_id: requestBody.rel_id
          ordernum: requestBody.ordernum
      - text: Move the field in membership {groupId} into group {group_id}.
        slots:
          groupId: path.groupId
          group_id: requestBody.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List user permission groups
      effect: read
      questions:
      - What user groups are set up in my ActiveCampaign account?
      - Can I list every permission group my users belong to?
      instructions:
      - text: List all user groups.
      - text: Show every permission group in the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user permission group
      effect: write
      questions:
      - How do I create a new user group with its own permissions?
      - Can I add a permission group for a new team?
      instructions:
      - text: 'Create a user group: {group}.'
        slots:
          group: requestBody.group
      - text: Set up a new permission group for the sales team.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a user permission group
      effect: read
      questions:
      - How do I view one user group's settings and permissions?
      - Can I fetch a single group by its ID?
      instructions:
      - text: Get user group {id}.
        slots:
          id: path.id
      - text: Show the permissions of group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user permission group
      effect: write
      questions:
      - How do I change the permissions or name of an existing user group?
      - Can I edit a group I already created?
      instructions:
      - text: Update user group {id} with {group}.
        slots:
          id: path.id
          group: requestBody.group
      - text: Rename permission group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user permission group
      effect: destructive
      questions:
      - How do I remove a user group I no longer need?
      - Can I delete a permission group by ID?
      instructions:
      - text: Delete user group {id}.
        slots:
          id: path.id
      - text: Remove permission group {id} from the account.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groupLimits'].get
  update:
    x-apievangelist-phrasing:
      intent: List sending limits for user groups
      effect: read
      questions:
      - What sending or usage limits apply to each user group?
      - Where do I see the group limits configured in my account?
      instructions:
      - text: List all group limits.
      - text: Show the limits set on each user group.
      method: generated
      generated: '2026-09-26'