Create Group

Use this API to create a group

JSON Parameter Description:

JSON Parameter

Required

Default

Description

clientGroupId

No

Unique identifier assigned to group from client.

groupName

Yes

Name of the group.

groupMemberList

Yes

List of userIds of the group members.

type

No

2

Type of the group.

imageUrl

No

Image url for group.

admin

No

Set another user as admin of the group.

📘

Note:

  • You can pass unique identifier in clientGroupId to identify groups. This can be useful in case you are storing group information in your backend and want to identify groups later.
  • If clientGroupId is not passed then Applozic will generate a unique id for the group which should be used as clientGroupId for all API calls.
  • In case of Application Bot calling the API, Of-User-Id header required. Of-User-Id is the userId of the user on behalf of which application bot wants to create a group.

📘

Admin of group

If admin parameter is not passed, the caller will be added as an admin of the group. In case you are calling this API with admin header, Of-User-Id will act as a caller and added as an admin of the group.

"type" parameter's possible values are given below:

Language
Authentication
Click Try It! to start a request and see the response here!