ActiveCampaign API v3 — Groups

naftiko: 1.0.0-alpha2
info:
  label: ActiveCampaign API v3 — Groups
  description: 'ActiveCampaign API v3 — Groups. 12 operations. Lead operation: ActiveCampaign Create a Custom Field Group.
    Self-contained Naftiko capability covering one Activecampaign business surface.'
  tags:
  - Activecampaign
  - Groups
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ACTIVECAMPAIGN_API_KEY: ACTIVECAMPAIGN_API_KEY
capability:
  consumes:
  - type: http
    namespace: v3-groups
    baseUri: https://{yourAccountName}.api-us1.com/api/3
    description: ActiveCampaign API v3 — Groups business capability. Self-contained, no shared references.
    resources:
    - name: groupDefinitions
      path: /groupDefinitions
      operations:
      - name: createacustomfieldgroup
        method: POST
        description: ActiveCampaign Create a Custom Field Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupDefinition.label
          in: query
          type: string
          description: Field Group Name
        - name: groupDefinition.ordernum
          in: query
          type: integer
          description: The order the custom field group will be shown
        - name: groupDefinition.groupType
          in: query
          type: integer
          description: The group type (see note)
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: groupLimits
      path: /groupLimits
      operations:
      - name: listallgrouplimits
        method: GET
        description: ActiveCampaign List All Group Limits
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groupMembers
      path: /groupMembers
      operations:
      - name: addcustomfieldtofieldgroup
        method: POST
        description: ActiveCampaign Add Custom Field to Field Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getallcustomfieldgroups
        method: GET
        description: ActiveCampaign Get All Custom Field Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groupMembers-groupID
      path: /groupMembers/{groupID}
      operations:
      - name: deletecustomfieldfieldgroup
        method: DELETE
        description: ActiveCampaign Delete Custom Field Field Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupID
          in: path
          type: string
          description: Group ID
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getcustomfieldtofieldgroup
        method: GET
        description: ActiveCampaign Get Custom Field Group by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupID
          in: path
          type: string
          description: Group ID
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: groupMembers-groupId
      path: /groupMembers/{groupId}
      operations:
      - name: updatecustomfieldfieldgroup
        method: PUT
        description: ActiveCampaign Update Custom Field Field Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupId
          in: path
          type: string
          description: Field group ID (see notes)
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: groups
      path: /groups
      operations:
      - name: createanewgroup
        method: POST
        description: ActiveCampaign Create a Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: listallgroups
        method: GET
        description: ActiveCampaign List All Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-id
      path: /groups/{id}
      operations:
      - name: retrieveagroup
        method: GET
        description: ActiveCampaign Retrieve a Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: ID of the group to retrieve
          required: true
      - name: updateagroup
        method: PUT
        description: ActiveCampaign Update a Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: ID of the group to update
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteagroup1
        method: DELETE
        description: ActiveCampaign Delete a Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: ID of the group to be deleted
          required: true
    authentication:
      type: apikey
      key: Api-Token
      value: '{{env.ACTIVECAMPAIGN_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: v3-groups-rest
    port: 8080
    description: REST adapter for ActiveCampaign API v3 — Groups. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/groupdefinitions
      name: groupdefinitions
      description: REST surface for groupDefinitions.
      operations:
      - method: POST
        name: createacustomfieldgroup
        description: ActiveCampaign Create a Custom Field Group
        call: v3-groups.createacustomfieldgroup
        with:
          groupDefinition.label: rest.groupDefinition.label
          groupDefinition.ordernum: rest.groupDefinition.ordernum
          groupDefinition.groupType: rest.groupDefinition.groupType
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/grouplimits
      name: grouplimits
      description: REST surface for groupLimits.
      operations:
      - method: GET
        name: listallgrouplimits
        description: ActiveCampaign List All Group Limits
        call: v3-groups.listallgrouplimits
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groupmembers
      name: groupmembers
      description: REST surface for groupMembers.
      operations:
      - method: POST
        name: addcustomfieldtofieldgroup
        description: ActiveCampaign Add Custom Field to Field Group
        call: v3-groups.addcustomfieldtofieldgroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getallcustomfieldgroups
        description: ActiveCampaign Get All Custom Field Groups
        call: v3-groups.getallcustomfieldgroups
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groupmembers/{groupid}
      name: groupmembers-groupid
      description: REST surface for groupMembers-groupID.
      operations:
      - method: DELETE
        name: deletecustomfieldfieldgroup
        description: ActiveCampaign Delete Custom Field Field Group
        call: v3-groups.deletecustomfieldfieldgroup
        with:
          groupID: rest.groupID
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getcustomfieldtofieldgroup
        description: ActiveCampaign Get Custom Field Group by ID
        call: v3-groups.getcustomfieldtofieldgroup
        with:
          groupID: rest.groupID
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groupmembers/{groupid}
      name: groupmembers-groupid
      description: REST surface for groupMembers-groupId.
      operations:
      - method: PUT
        name: updatecustomfieldfieldgroup
        description: ActiveCampaign Update Custom Field Field Group
        call: v3-groups.updatecustomfieldfieldgroup
        with:
          groupId: rest.groupId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups
      name: groups
      description: REST surface for groups.
      operations:
      - method: POST
        name: createanewgroup
        description: ActiveCampaign Create a Group
        call: v3-groups.createanewgroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listallgroups
        description: ActiveCampaign List All Groups
        call: v3-groups.listallgroups
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/{id}
      name: groups-id
      description: REST surface for groups-id.
      operations:
      - method: GET
        name: retrieveagroup
        description: ActiveCampaign Retrieve a Group
        call: v3-groups.retrieveagroup
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateagroup
        description: ActiveCampaign Update a Group
        call: v3-groups.updateagroup
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteagroup1
        description: ActiveCampaign Delete a Group
        call: v3-groups.deleteagroup1
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v3-groups-mcp
    port: 9090
    transport: http
    description: MCP adapter for ActiveCampaign API v3 — Groups. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: activecampaign-create-custom-field-group
      description: ActiveCampaign Create a Custom Field Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v3-groups.createacustomfieldgroup
      with:
        groupDefinition.label: tools.groupDefinition.label
        groupDefinition.ordernum: tools.groupDefinition.ordernum
        groupDefinition.groupType: tools.groupDefinition.groupType
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-list-all-group-limits
      description: ActiveCampaign List All Group Limits
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v3-groups.listallgrouplimits
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-add-custom-field-field
      description: ActiveCampaign Add Custom Field to Field Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v3-groups.addcustomfieldtofieldgroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-get-all-custom-field
      description: ActiveCampaign Get All Custom Field Groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v3-groups.getallcustomfieldgroups
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-delete-custom-field-field
      description: ActiveCampaign Delete Custom Field Field Group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v3-groups.deletecustomfieldfieldgroup
      with:
        groupID: tools.groupID
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-get-custom-field-group
      description: ActiveCampaign Get Custom Field Group by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v3-groups.getcustomfieldtofieldgroup
      with:
        groupID: tools.groupID
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-update-custom-field-field
      description: ActiveCampaign Update Custom Field Field Group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v3-groups.updatecustomfieldfieldgroup
      with:
        groupId: tools.groupId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-create-group
      description: ActiveCampaign Create a Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v3-groups.createanewgroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-list-all-groups
      description: ActiveCampaign List All Groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v3-groups.listallgroups
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-retrieve-group
      description: ActiveCampaign Retrieve a Group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v3-groups.retrieveagroup
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-update-group
      description: ActiveCampaign Update a Group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v3-groups.updateagroup
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-delete-group
      description: ActiveCampaign Delete a Group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v3-groups.deleteagroup1
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.