Mapp Marketing Cloud · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Mapp Engage public Group API
12 actions
12 updates
phrasing
extends
openapi/mapp-group-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Mapp Marketing Cloud's API. It is a proposal applied on top of the contract, not a document Mapp Marketing Cloud publishes.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/group/activate'].post
$.paths['/group/archive'].post
$.paths['/group/clone'].post
$.paths['/group/create'].post
$.paths['/group/findIdsByAttributes'].post
$.paths['/group/get'].get
$.paths['/group/getAttributes'].get
$.paths['/group/getAllGroupSettingsTemplates'].get
$.paths['/group/getPreparedMessages'].get
$.paths['/group/overrideGroupSettings'].post
$.paths['/group/setAttributes'].post
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 Mapp Engage public Group API
version: 1.0.0
extends: openapi/mapp-group-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: 11
- target: $.paths['/group/activate'].post
update:
x-apievangelist-phrasing:
intent: Reactivate archived groups
effect: write
questions:
- Can I bring archived groups back into active use?
- How do I reactivate several archived groups at once?
instructions:
- text: Reactivate archived groups 1800123820 and 1800146953.
- text: Unarchive the groups I list.
method: generated
generated: '2026-09-26'
- target: $.paths['/group/archive'].post
update:
x-apievangelist-phrasing:
intent: Archive groups and their subgroups
effect: write
questions:
- What happens to subgroups when I archive a group?
- Are triggers and scheduled tasks archived along with a group?
instructions:
- text: Archive these groups and their subgroups.
- text: Archive group 1800123820.
method: generated
generated: '2026-09-26'
- target: $.paths['/group/clone'].post
update:
x-apievangelist-phrasing:
intent: Clone an existing group
effect: write
questions:
- Can I duplicate a group with its sendout settings but without its members?
- Does cloning a group copy the group members?
instructions:
- text: Clone group {groupId} under a new name.
slots:
groupId: query.groupId
- text: Make a copy of group {groupId} with the same delivery settings.
slots:
groupId: query.groupId
method: generated
generated: '2026-09-26'
- target: $.paths['/group/create'].post
update:
x-apievangelist-phrasing:
intent: Create a new group
effect: write
questions:
- How do I create a new mailing group in Mapp Engage?
- Which country and language must I set when creating a group?
- Can I create a supergroup from a group template?
instructions:
- text: Create group {name} with sender email {email}, country {isoCountryCode}, language {isoLanguageCode}, supergroup {isSuperGroup}.
slots:
name: query.name
email: query.email
isoCountryCode: query.isoCountryCode
isoLanguageCode: query.isoLanguageCode
isSuperGroup: query.isSuperGroup
- text: Create group {name} from template {groupTemplateId}.
slots:
name: query.name
groupTemplateId: query.groupTemplateId
method: generated
generated: '2026-09-26'
- target: $.paths['/group/findIdsByAttributes'].post
update:
x-apievangelist-phrasing:
intent: Find groups by group attribute values
effect: read
questions:
- Which groups have a particular group attribute value set?
- Can I search groups by group name through the attribute search?
instructions:
- text: Find the IDs of groups whose Region group attribute is EMEA.
- text: Look up group IDs matching these group attribute values.
method: generated
generated: '2026-09-26'
- target: $.paths['/group/get'].get
update:
x-apievangelist-phrasing:
intent: Get a group's details
effect: read
questions:
- What settings and details does a specific group have?
- Can I look up a group's name and email by its ID?
instructions:
- text: Get the details of group {groupId}.
slots:
groupId: query.groupId
- text: Show me group {groupId}.
slots:
groupId: query.groupId
method: generated
generated: '2026-09-26'
- target: $.paths['/group/getAttributes'].get
update:
x-apievangelist-phrasing:
intent: Get all attributes of a group
effect: read
questions:
- What group attribute values are set on this group?
- Can I see every name-value attribute attached to a group?
instructions:
- text: List all attribute values set on group {groupId}.
slots:
groupId: query.groupId
- text: Show the group attributes of {groupId}.
slots:
groupId: query.groupId
method: generated
generated: '2026-09-26'
- target: $.paths['/group/getAllGroupSettingsTemplates'].get
update:
x-apievangelist-phrasing:
intent: List group settings templates
effect: read
questions:
- Which group settings templates are defined in our system?
- Where do I find the template IDs used to override group settings?
instructions:
- text: List all group settings templates.
- text: Show the available group settings templates.
method: generated
generated: '2026-09-26'
- target: $.paths['/group/getPreparedMessages'].get
update:
x-apievangelist-phrasing:
intent: List a group's prepared messages
effect: read
questions:
- Which prepared messages are ready to send for a group?
- Can I see all saved prepared messages belonging to one group?
instructions:
- text: List the prepared messages for group {groupId}.
slots:
groupId: query.groupId
- text: Show what prepared messages group {groupId} has.
slots:
groupId: query.groupId
method: generated
generated: '2026-09-26'
- target: $.paths['/group/overrideGroupSettings'].post
update:
x-apievangelist-phrasing:
intent: Apply a settings template to a group
effect: write
questions:
- Can I overwrite a group's settings with a predefined template?
- What happens to a group's current settings when a template is applied?
instructions:
- text: Apply settings template {settingsId} to group {groupId}.
slots:
settingsId: query.settingsId
groupId: query.groupId
- text: Override group {groupId}'s settings with template {settingsId}.
slots:
groupId: query.groupId
settingsId: query.settingsId
method: generated
generated: '2026-09-26'
- target: $.paths['/group/setAttributes'].post
update:
x-apievangelist-phrasing:
intent: Set attribute values on a group
effect: write
questions:
- How do I set or overwrite attribute values on a group?
- Will setting group attributes replace values already there?
instructions:
- text: Set GroupAttributeName to 12345 on group {groupId}.
slots:
groupId: query.groupId
- text: Write these attribute values onto group {groupId}.
slots:
groupId: query.groupId
method: generated
generated: '2026-09-26'