Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Description
Create a new group.
For domain, check Mapp Engage > Create > New GroupReturns Object Already Exists Exception
Available from |
|---|
v1 |
Request path
POST [REST URL]/group/create
Query Parameters
Parameter | Type | Description | Constraint | Example value |
|---|---|---|---|---|
name | The name of the group. | required | group | |
| String | The email address of the group. | required, unique | groupa@mydomain | |
description | The description of the group. | optional | ||
groupCategoryId | The group category | optional | ||
isoCountryCode | The ISO country code | required | GB | |
isoLanguageCode | The ISO language code | required | en | |
isSuperGroup | Should be a supergroup | required | false | |
groupTemplateId | The ID of groupTemplate | optional | 34 |
Successful response - groupId
| Code Block |
|---|
{
1900328197
} |
Unsuccessful response
| Code Block |
|---|
{
"errorActor": "CLIENT",
"errorCode": "OBJECT_ALREADY_EXISTS",
"message": "Group with group.Email= ... does already exist.",
"objectType": "Group",
"propertyName": "group.Email",
"propertyValue": "..."
} |