ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ActiveCampaign API v3 Notes API

6 actions 6 updates phrasing extends openapi/activecampaign-notes-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for ActiveCampaign's API. It is a proposal applied on top of the contract, not a document ActiveCampaign publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/notes'].get

$.paths['/notes'].post

$.paths['/notes/{id}'].get

$.paths['/notes/{id}'].put

$.paths['/notes/{id}'].delete

OpenAPI Overlay

# 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 Notes API
  version: 1.0.0
extends: openapi/activecampaign-notes-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['/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List all notes
      effect: read
      questions:
      - What notes have been written across my ActiveCampaign account?
      - Can I see every note in one list?
      instructions:
      - text: List all notes.
      - text: Show me every note on the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a note
      effect: write
      questions:
      - How do I add a note to a contact, deal or account record?
      - Can I create a standalone note through the API?
      instructions:
      - text: 'Create a note: {note}.'
        slots:
          note: requestBody.note
      - text: Write a note on this contact about today's call.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a note
      effect: read
      questions:
      - Where do I read a single note by its ID?
      - What does note 20 say?
      instructions:
      - text: Show note {id}.
        slots:
          id: path.id
      - text: Read the text of note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notes/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a note
      effect: write
      questions:
      - Can I edit the text of an existing note?
      - Is it possible to correct a note after saving it?
      instructions:
      - text: Update note {id} to say {note}.
        slots:
          id: path.id
          note: requestBody.note
      - text: Edit note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notes/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a note
      effect: destructive
      questions:
      - How do I delete a note?
      - Can I permanently remove a note written by mistake?
      instructions:
      - text: Delete note {id}.
        slots:
          id: path.id
      - text: Remove the mistaken note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'