openapi: 3.2.0
info:
  title: Mapp Engage public CMS 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: CMS
paths:
  /cms/getMimeMessage:
    get:
      tags:
      - CMS
      summary: Get a CMS message as MIME
      description: Returns the specified CMS message in MIME message format.
      operationId: getMimeMessage
      parameters:
      - name: cmsMessageId
        in: query
        description: The ID of the CMS message to be returned.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CmsMessageDefinition'
            application/xml:
              schema:
                $ref: '#/components/schemas/CmsMessageDefinition'
        '400':
          description: 'Error response: {<br>"errorActor": "CLIENT",<br>"errorCode": "NO_SUCH_OBJECT",<br>"message": "No cms message found with id ''81301''!",<br>"objectType": null,<br>"propertyName": null,<br>"propertyValue": null<br>}'
  /cms/getMessageDefinitions:
    get:
      tags:
      - CMS
      summary: List CMS message definitions
      description: Returns a list of all CMS messages that are saved in the system.<br>Every CMS message contains detailed information that identifies the message and the template that was used for creation.
      operationId: getMessageDefinitions
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CmsMessageDefinition'
            application/xml:
              schema:
                $ref: '#/components/schemas/CmsMessageDefinition'
        '400':
          description: ''
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