Mapp Marketing Cloud Group API

The Group API from Mapp Marketing Cloud — 11 operation(s) for group.

Documentation GitHub OpenAPI

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /group/activate Reactivate archived groups · Activate groups #

Ask an LLM

“Can I bring archived groups back into active use?”

“How do I reactivate several archived groups at once?”

Tell an agent

Reactivate archived groups 1800123820 and 1800146953.

Unarchive the groups I list.

POST /group/archive Archive groups and their subgroups · Archive groups #

Ask an LLM

“What happens to subgroups when I archive a group?”

“Are triggers and scheduled tasks archived along with a group?”

Tell an agent

Archive these groups and their subgroups.

Archive group 1800123820.

POST /group/clone Clone an existing group · Clone a group #

Ask an LLM

“Can I duplicate a group with its sendout settings but without its members?”

“Does cloning a group copy the group members?”

Tell an agent

Clone group {groupId} under a new name.

Make a copy of group {groupId} with the same delivery settings.

POST /group/create Create a new group · Create a group #

Ask an LLM

“How do I create a new mailing group in Mapp Engage?”

“Which country and language must I set when creating a group?”

Tell an agent

Create group {name} with sender email {email}, country {isoCountryCode}, language {isoLanguageCode}, supergroup {isSuperGroup}.

Create group {name} from template {groupTemplateId}.

POST /group/findIdsByAttributes Find groups by group attribute values · Find group IDs by attributes #

Ask an LLM

“Which groups have a particular group attribute value set?”

“Can I search groups by group name through the attribute search?”

Tell an agent

Find the IDs of groups whose Region group attribute is EMEA.

Look up group IDs matching these group attribute values.

GET /group/get Get a group's details · Get a group #

Ask an LLM

“What settings and details does a specific group have?”

“Can I look up a group's name and email by its ID?”

Tell an agent

Get the details of group {groupId}.

Show me group {groupId}.

GET /group/getAttributes Get all attributes of a group · Get group attributes #

Ask an LLM

“What group attribute values are set on this group?”

“Can I see every name-value attribute attached to a group?”

Tell an agent

List all attribute values set on group {groupId}.

Show the group attributes of {groupId}.

GET /group/getAllGroupSettingsTemplates List group settings templates · List group settings templates #

Ask an LLM

“Which group settings templates are defined in our system?”

“Where do I find the template IDs used to override group settings?”

Tell an agent

List all group settings templates.

Show the available group settings templates.

GET /group/getPreparedMessages List a group's prepared messages · List prepared messages for a group #

Ask an LLM

“Which prepared messages are ready to send for a group?”

“Can I see all saved prepared messages belonging to one group?”

Tell an agent

List the prepared messages for group {groupId}.

Show what prepared messages group {groupId} has.

POST /group/overrideGroupSettings Apply a settings template to a group · Override group settings #

Ask an LLM

“Can I overwrite a group's settings with a predefined template?”

“What happens to a group's current settings when a template is applied?”

Tell an agent

Apply settings template {settingsId} to group {groupId}.

Override group {groupId}'s settings with template {settingsId}.

POST /group/setAttributes Set attribute values on a group · Set group attributes #

Ask an LLM

“How do I set or overwrite attribute values on a group?”

“Will setting group attributes replace values already there?”

Tell an agent

Set GroupAttributeName to 12345 on group {groupId}.

Write these attribute values onto group {groupId}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/mapp:mapp-group-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Mapp Engage public Group 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: Group
paths:
  /group/activate:
    post:
      tags:
      - Group
      summary: Activate groups
      description: 'Activates archived groups.

        Request body example:


        ["1800123820", "1800146953"]'
      operationId: activate
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
            application/xml:
              schema:
                type: array
                items:
                  type: object
        '204':
          description: 'Example response: <br><br>[{<br>    "entityKey": "1800123820",<br>    "code": null,<br>    "message": null }, {<br>    "entityKey": "1800146953",<br>    "code": null,<br>    "message": null<br>}]'
        '400':
          description: Provided list of groupIds is empty
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: integer
                format: int64
  /group/archive:
    post:
      tags:
      - Group
      summary: Archive groups
      description: 'Archive a list of groups and any dependent subgroups. Other dependent objects, such as triggers and scheduled tasks, are not archived.

        Request body example:


        ["1800123820", "1800146953"]'
      operationId: archive
      responses:
        '200':
          description: 'Example response: <br><br>[{<br>"entityKey": "80375",<br>"code": null,<br>"message": null<br>}]'
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
            application/xml:
              schema:
                type: array
                items:
                  type: object
        '400':
          description: Provided list of groupIds is empty
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: integer
                format: int64
  /group/clone:
    post:
      tags:
      - Group
      summary: Clone a group
      description: 'Creates a clone of a group that already exists in the system.

        Most of the sendout options and delivery settings are identical for the original and the clone.

        Group members are not copied

        Request body example:


        {

        "name" : "Group Name",

        "description" : "Description of the group",

        "email" : "group@test.com",

        "includePreparedMessages" : "true",

        "includeTestUsers" : "false"

        }'
      operationId: clone
      parameters:
      - name: groupId
        in: query
        description: ID of the group to be cloned
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: 'Example response: <br><br>{<br>"id": 80376,<br>"name": "CloneOfTestGroup0803022-1",<br>"description": "magna labore dolor eu Lorem",<br>"email": "cloneoftestgroup0803022-1@docker01.dmclab.muc.domeus.com"<br>}'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
            application/xml:
              schema:
                $ref: '#/components/schemas/Group'
        '400':
          description: Required parameters are missing or incorrect. Group with groupId cannot be found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupCloneOptions'
  /group/create:
    post:
      tags:
      - Group
      summary: Create a group
      description: 'Create a new group.

        For domain, check Mapp Engage > Create > New Group

        Returns Object Already Exists Exception'
      operationId: CreateGroup
      parameters:
      - name: name
        in: query
        description: The name of the group.
        required: true
        schema:
          type: string
      - name: email
        in: query
        description: The email address of the group.
        required: true
        schema:
          type: string
      - name: description
        in: query
        description: The description of the group.
        required: false
        schema:
          type: string
      - name: groupCategoryId
        in: query
        description: The group category
        required: false
        schema:
          type: integer
          format: int64
      - name: isoCountryCode
        in: query
        description: The ISO country code
        required: true
        schema:
          type: string
      - name: isoLanguageCode
        in: query
        description: The ISO language code
        required: true
        schema:
          type: string
      - name: isSuperGroup
        in: query
        description: Should be a supergroup
        required: true
        schema:
          type: boolean
      - name: groupTemplateId
        in: query
        description: The ID of groupTemplate
        required: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: integer
                format: int64
            application/xml:
              schema:
                type: integer
                format: int64
        '204':
          description: 'Example response: <br><br>{<br>1900328197<br>}'
        '400':
          description: Required parameters are missing or incorrect / Group already exists
  /group/findIdsByAttributes:
    post:
      tags:
      - Group
      summary: Find group IDs by attributes
      description: 'Returns a list of group IDs for all groups in the system that use the specified group attributes.

        Group attributes are only available in the group context and consist of a unique name and a value.

        Please note that attributes like Group Name or Email cannot be used here.

        Request body example:


        [{

        "name" : " GroupAttributeName ",

        "value" : "12345"

        }]'
      operationId: findIdsByAttributes
      responses:
        '200':
          description: 'Example response: <br><br>[1800123829]'
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
            application/xml:
              schema:
                type: array
                items:
                  type: object
        '400':
          description: '"message": "The provided JSON object representation is incorrect."'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Attribute'
  /group/get:
    get:
      tags:
      - Group
      summary: Get a group
      description: Returns the group object of the specified group. The group is identified by group ID.
      operationId: GetGroup
      parameters:
      - name: groupId
        in: query
        description: ID of the group to be cloned
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: 'Example response: <br><br><br>{<br>    "id": 1800150437,<br>    "name": "Group Name",<br>    "description": "Description of the group",<br>    "email": "group@test.com"<br>}'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
            application/xml:
              schema:
                $ref: '#/components/schemas/Group'
        '400':
          description: Required parameters are missing or incorrect. Group with groupId cannot be found
        '404':
          description: 'Error response: {<br>"errorActor": "CLIENT",<br>"errorCode": "INVALID_REQUEST",<br>"message": "Not Found"<br>}'
  /group/getAttributes:
    get:
      tags:
      - Group
      summary: Get group attributes
      description: Provides a list of all group attributes.
      operationId: getAttributes
      parameters:
      - name: groupId
        in: query
        description: ID of the group for which we request the parameters.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: 'Example response: <br><br>[{<br>    "name": "Test",<br>    "value": "12345" }, {<br>    "name": "TestRest",<br>    "value": "12345"<br>}]'
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
            application/xml:
              schema:
                type: array
                items:
                  type: object
        '400':
          description: Required parameters are missing or incorrect.
        '404':
          description: 'Error response: {<br>"errorActor": "CLIENT",<br>"errorCode": "INVALID_REQUEST",<br>"message": "Not Found"<br>}'
  /group/getAllGroupSettingsTemplates:
    get:
      tags:
      - Group
      summary: List group settings templates
      description: 'Gets all GroupSettingsTemplates that are defined in the system.

        GroupSettingTemplates predefine several settings in a template and can be applied using /group/overrideGroupSettings call.

        The mechanism for using GroupSettingTemplates is only available in a special configuration.'
      operationId: getAllGroupSettingsTemplates
      responses:
        '200':
          description: 'Example response: <br><br>[{<br>"id": 1,<br>"name": "test template 0903"<br>}]'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupSettingsTemplate'
            application/xml:
              schema:
                $ref: '#/components/schemas/GroupSettingsTemplate'
        '400':
          description: ''
  /group/getPreparedMessages:
    get:
      tags:
      - Group
      summary: List prepared messages for a group
      description: Returns all of the prepared messages for a specific group.
      operationId: getPreparedMessages
      parameters:
      - name: groupId
        in: query
        description: ID of the group for which we request the messages
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: 'Example response: <br><br>[1800197358]'
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
            application/xml:
              schema:
                type: array
                items:
                  type: object
        '400':
          description: 'Required parameters are missing or incorrect. Error response: {<br>"errorActor": "CLIENT",<br>"errorCode": "PERMISSION_DENIED",<br>"message": "Permission ''message_view'' denied: SystemUser ''1'' on group ''803725555''.",<br>"errorId": null<br>}'
        '404':
          description: 'Error response: {<br>"errorActor": "CLIENT",<br>"errorCode": "INVALID_REQUEST",<br>"message": "Not Found"<br>}'
  /group/overrideGroupSettings:
    post:
      tags:
      - Group
      summary: Override group settings
      description: Overwrites the existing group settings with a new template.
      operationId: GroupOverrideGroupSettings
      parameters:
      - name: groupId
        in: query
        description: ID of the group for which we change the settings.
        required: true
        schema:
          type: integer
          format: int64
      - name: settingsId
        in: query
        description: ID of the configuration template.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: ''
        '400':
          description: 'Required parameters are missing or incorrect. Error response: {<br>"errorActor": "CLIENT",<br>"errorCode": "MISSING_PARAMETER",<br>"message": "Parameter ''groupId'' is mandatory but no value was specified.",<br>"parameterName": "groupId",<br>"propertyName": null,<br>"value": "null"<br>}'
  /group/setAttributes:
    post:
      tags:
      - Group
      summary: Set group attributes
      description: 'Creates and updates the group attributes. Existing attributes are overwritten.

        Request body example:


        [{

        "name" : "GroupAttributeName",

        "value" : "12345"

        }]'
      operationId: setAttributes
      parameters:
      - name: groupId
        in: query
        description: ID of the group for which we request the parameters.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: 'Example response: <br><br>{<br>1}'
        '400':
          description: Required parameters are missing or incorrect.
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Attribute'
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

Mapp Marketing Cloud Group API

Operations 11

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification