openapi: 3.2.0
info:
  title: Mapp Engage public System User API
  version: '1'
  description: 'Mapp Engage REST API (REST 2.0, incremental version v19). Assembled verbatim from the per-operation OpenAPI fragments Mapp publishes on each endpoint page of https://docs.mapp.com/apidocs/. The base URL is tenant-specific: take your Mapp Engage login host and append /api/rest/v19.'
  contact:
    name: Mapp Technical Support
    url: https://mapp.com/tech-support/
servers:
- url: /api/rest/v19
security:
- basicAuth: []
tags:
- name: System User
paths:
  /systemuser/create:
    post:
      tags:
      - System User
      summary: Create a system user
      description: Creates the new system user in the system.<br>Request body example:<br><br><pre>{<br>"email":"test1@test.mapp",<br>"firstName":"sf53sd",<br>"lastName":"zf8hzt",<br>"language":"en",<br>"type":"hybrid",<br>"messagingRole":"project_manager"<br>}</pre>
      operationId: createSystemUser
      parameters:
      - name: createContact
        in: query
        description: Flag that determines whether to create a contact
        required: true
        schema:
          type: boolean
      - name: suppressSystemMessage
        in: query
        description: Flag that determines suppressing system message
        required: true
        schema:
          type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemUser'
            application/xml:
              schema:
                $ref: '#/components/schemas/SystemUser'
        '400':
          description: ''
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SystemUser'
  /systemuser/delete:
    delete:
      tags:
      - System User
      summary: Delete a system user
      description: Deletes the system user identified by the specified system user ID, external ID, or email address.
      operationId: deleteSystemUser
      parameters:
      - name: systemUserId
        in: query
        description: ID of the user
        required: true
        schema:
          type: integer
          format: int64
      - name: email
        in: query
        description: Email of the user
        required: true
        schema:
          type: string
      - name: externalId
        in: query
        description: External ID of the user
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        '400':
          description: ''
  /systemuser/get:
    get:
      tags:
      - System User
      summary: Get a system user
      description: 'Retrieves the system user identified by the specified system user ID, external ID, or email address.Note: It is not required to fill all params fields. It''s enough to fill just one field out off three (systemUserId or email)'
      operationId: getSystemUser
      parameters:
      - name: systemUserId
        in: query
        description: ID of the user
        required: true
        schema:
          type: integer
          format: int64
      - name: email
        in: query
        description: Email of the user
        required: true
        schema:
          type: string
      - name: externalId
        in: query
        description: External ID of the user
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemUser'
            application/xml:
              schema:
                $ref: '#/components/schemas/SystemUser'
        '400':
          description: ''
        '404':
          description: 'Error response: {<br>"errorActor": "CLIENT",<br>"errorCode": "INVALID_REQUEST",<br>"message": "Not Found"<br>}'
  /systemuser/updatePassword:
    post:
      tags:
      - System User
      summary: Update a system user's password
      description: Updates or create the system user password identified by the specified system user ID.<br>Request body example:<br><br><pre>{<br>    "systemUserId":1234,<br>    "password":"abcd1234"<br>}</pre>
      operationId: updatePassword
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/CallResult'
        '400':
          description: ''
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCredentials'
  /systemuser/update:
    post:
      tags:
      - System User
      summary: Update a system user
      description: Updates the existing system user in the system.
      operationId: updateSystemUser
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemUser'
            application/xml:
              schema:
                $ref: '#/components/schemas/SystemUser'
        '400':
          description: ''
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SystemUser'
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with a Mapp Engage system user of type API (or Hybrid).
x-apievangelist-provenance:
  method: searched
  generated: '2026-08-12'
  source: https://docs.mapp.com/apidocs/ (per-endpoint OpenAPI fragments)
  note: Union of the OpenAPI JSON fragments Mapp publishes on each endpoint page. Mapp does not serve one consolidated document at a public URL; the tenant-served Swagger lives at https://<your-engage-host>/apidoc/swagger.json and requires a tenant. Operation bodies, parameters, responses, tags, summaries and descriptions are verbatim from Mapp. The swagger/basePath/schemes/securityDefinitions envelope is added by API Evangelist from the published Getting Started guide; no operation content was authored.
  duplicate_operation_ids_suffixed: 30