Contents

POST [/instances/$INSTANCES]/private/groups#

This is used to create a group.

Required permission: groups-write

Request:

The request must be a GroupAddRequest.

Response:

200 OK:

The backend has successfully added a new group. Returns a GroupAddedResponse.

404 Not found:

The merchant instance is unknown.

Details:

interface GroupAddRequest {

  // Unique name for the group (unique per instance).
  group_name: string;

  // Description of the group.
  description: string;

}
interface GroupAddedResponse {

  // Unique ID for the group.
  group_serial_id: Integer;

}