# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mapp Engage public System User API
  version: 1.0.0
extends: openapi/mapp-system-user-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['/systemuser/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a system user account
      effect: write
      questions:
      - How do I give a new colleague access to Mapp Engage?
      - Can I create a system user without sending them a system message?
      - Is a matching contact created automatically for a new system user?
      instructions:
      - text: Create a system user with createContact {createContact} and suppressSystemMessage {suppressSystemMessage}.
        slots:
          createContact: query.createContact
          suppressSystemMessage: query.suppressSystemMessage
      - text: 'Add a project manager system user for anna@example.com, suppress system message: {suppressSystemMessage}.'
        slots:
          suppressSystemMessage: query.suppressSystemMessage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/systemuser/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a system user account
      effect: destructive
      questions:
      - How do I remove a colleague's login when they leave?
      - Can I delete a system user by external ID instead of email?
      instructions:
      - text: Delete the system user with email {email}.
        slots:
          email: query.email
      - text: Remove system user {systemUserId}.
        slots:
          systemUserId: query.systemUserId
      - text: Delete the system user with external ID {externalId}.
        slots:
          externalId: query.externalId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/systemuser/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a system user account
      effect: read
      questions:
      - What role and language does a given system user have?
      - Can I find a system user using only one of ID, email or external ID?
      instructions:
      - text: Get the system user with email {email}.
        slots:
          email: query.email
      - text: Look up system user {systemUserId}.
        slots:
          systemUserId: query.systemUserId
      - text: Find the system user whose external ID is {externalId}.
        slots:
          externalId: query.externalId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/systemuser/updatePassword'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a system user's password
      effect: write
      questions:
      - How do I reset a colleague's login password?
      - Can I set a password for a system user who doesn't have one yet?
      instructions:
      - text: Set a new password for system user 1234.
      - text: Reset the login password of this system user.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/systemuser/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a system user's details
      effect: write
      questions:
      - Can I change a system user's name or messaging role?
      - What details of an existing system user can be edited?
      instructions:
      - text: Update this system user's messaging role to project manager.
      - text: Change the first and last name on an existing system user.
      method: generated
      generated: '2026-09-26'