ActiveCampaign API v3 — Notes

naftiko: 1.0.0-alpha2
info:
  label: ActiveCampaign API v3 — Notes
  description: 'ActiveCampaign API v3 — Notes. 5 operations. Lead operation: ActiveCampaign Retrieve List of All Notes. Self-contained
    Naftiko capability covering one Activecampaign business surface.'
  tags:
  - Activecampaign
  - Notes
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ACTIVECAMPAIGN_API_KEY: ACTIVECAMPAIGN_API_KEY
capability:
  consumes:
  - type: http
    namespace: v3-notes
    baseUri: https://{yourAccountName}.api-us1.com/api/3
    description: ActiveCampaign API v3 — Notes business capability. Self-contained, no shared references.
    resources:
    - name: notes
      path: /notes
      operations:
      - name: retrievelistofallnotes
        method: GET
        description: ActiveCampaign Retrieve List of All Notes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createanote
        method: POST
        description: ActiveCampaign Create a Note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: notes-id
      path: /notes/{id}
      operations:
      - name: retrieveanote
        method: GET
        description: ActiveCampaign Retrieve a Note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: ID of the note to retrieve
          required: true
      - name: updateanote
        method: PUT
        description: ActiveCampaign Update a Note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: ID of the note to update
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletenote
        method: DELETE
        description: ActiveCampaign Delete a Note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: ID of the note to delete
          required: true
    authentication:
      type: apikey
      key: Api-Token
      value: '{{env.ACTIVECAMPAIGN_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: v3-notes-rest
    port: 8080
    description: REST adapter for ActiveCampaign API v3 — Notes. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/notes
      name: notes
      description: REST surface for notes.
      operations:
      - method: GET
        name: retrievelistofallnotes
        description: ActiveCampaign Retrieve List of All Notes
        call: v3-notes.retrievelistofallnotes
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createanote
        description: ActiveCampaign Create a Note
        call: v3-notes.createanote
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notes/{id}
      name: notes-id
      description: REST surface for notes-id.
      operations:
      - method: GET
        name: retrieveanote
        description: ActiveCampaign Retrieve a Note
        call: v3-notes.retrieveanote
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateanote
        description: ActiveCampaign Update a Note
        call: v3-notes.updateanote
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletenote
        description: ActiveCampaign Delete a Note
        call: v3-notes.deletenote
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v3-notes-mcp
    port: 9090
    transport: http
    description: MCP adapter for ActiveCampaign API v3 — Notes. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: activecampaign-retrieve-list-all-notes
      description: ActiveCampaign Retrieve List of All Notes
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v3-notes.retrievelistofallnotes
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-create-note
      description: ActiveCampaign Create a Note
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v3-notes.createanote
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-retrieve-note
      description: ActiveCampaign Retrieve a Note
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v3-notes.retrieveanote
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-update-note
      description: ActiveCampaign Update a Note
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v3-notes.updateanote
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-delete-note
      description: ActiveCampaign Delete a Note
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v3-notes.deletenote
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.