ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ActiveCampaign API v3 Users API

9 actions 9 updates phrasing extends openapi/activecampaign-users-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 9

$.info

$.paths['/users'].get

$.paths['/users'].post

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

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

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

$.paths['/users/email/{email}'].get

$.paths['/users/username/{username}'].get

$.paths['/users/me'].get

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 Users API
  version: 1.0.0
extends: openapi/activecampaign-users-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['/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List account users
      effect: read
      questions:
      - Who has a user login on my ActiveCampaign account?
      - Can I see every team member set up as a user?
      instructions:
      - text: List all users on the account.
      - text: Show every team member with a login.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user
      effect: write
      questions:
      - How do I add a new teammate as a user?
      - Can I create a user login and assign them to a group?
      instructions:
      - text: Create a user with {user}.
        slots:
          user: requestBody.user
      - text: Add a new team member login.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user by ID
      effect: read
      questions:
      - What details are stored for a user with a given ID?
      - Can I look up a teammate by their numeric user ID?
      instructions:
      - text: Show user {id}.
        slots:
          id: path.id
      - text: Get the profile of user ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user
      effect: write
      questions:
      - Can I change a teammate's name, email or group?
      - How do I edit an existing user?
      instructions:
      - text: Update user {id} with {user}.
        slots:
          id: path.id
          user: requestBody.user
      - text: Edit the profile of user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user
      effect: destructive
      questions:
      - How do I remove a teammate who has left?
      - Can I delete a user login from the account?
      instructions:
      - text: Delete user {id}.
        slots:
          id: path.id
      - text: Remove team member {id} from the account.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/email/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a user by email
      effect: read
      questions:
      - Which user account belongs to a given email address?
      - Can I look up a teammate by email instead of ID?
      instructions:
      - text: Find the user with email {email}.
        slots:
          email: path.email
      - text: Look up the team member whose email is {email}.
        slots:
          email: path.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/username/{username}'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a user by username
      effect: read
      questions:
      - Who is the user behind a particular username?
      - Can I fetch a user record using only their login name?
      instructions:
      - text: Find the user with username {username}.
        slots:
          username: path.username
      - text: Look up team member {username} by login name.
        slots:
          username: path.username
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the logged-in user
      effect: read
      questions:
      - Which user does my API key belong to?
      - Can I see the profile of the user I'm authenticated as?
      instructions:
      - text: Show my own user profile.
      - text: Tell me which user is currently logged in.
      method: generated
      generated: '2026-09-26'