Group
Payload Parameters
| Field | Type | Required | Description | Format Allowed |
|---|---|---|---|---|
| kindlyPartnerGroupId | String | ✔ | Group's ID. (from Kindly) | Any string value |
| partnerGroupId | String | ✔ | Group's ID. (from Partner) | Any string value |
| partnerGroupName | String | ✔ | Group's Name. *Displayed in the app. | Any string value |
| partnerGroupJoinCode | String | ✔ | Group's Join Code. | Any string value |
| partnerGroupType | Integer | ✔ | Group's Type. | An integer from 1 to 7 Learn more in Group Type enum |
| kindlyUserId | String | ✔ | The User ID of the Group Leader. | Any string value |
| partnerGroupUserCount | Integer | ✔ | The maximum number of Volunteers that can join the Group. | Positive integer, greater than 0 |
| groupOpenUserSlots | Integer | ✔ | The number of open slots in the Group. | Positive integer, greater than or equal to 0 |
| kindlyRegisteredUserCount | Integer | ✔ | The number of registered Users who are members of the Group. | Positive integer, greater than or equal to 0 |
| partnerRegisteredUserCount | Integer | ✔ | The number of non-Kindly Users who are members of the Group. | Positive integer, greater than or equal to 0 |
| kindlyInviteeUserCount | Integer | ✔ | The number of Invited Name in the Group. | Positive integer, greater than or equal to 0 |
Example Object Payload
{
"kindlyPartnerGroupId": "d223d859edae404290fc6d79a393aa24",
"partnerGroupId": "0123456789abc",
"partnerGroupName": "The Cool Group",
"partnerGroupJoinCode": "abc123456",
"partnerGroupType": 4,
"kindlyUserId": "10473963d373401fa1430096bfb38da7",
"partnerGroupUserCount": 20,
"groupOpenUserSlots": 3,
"kindlyRegisteredUserCount": 10,
"partnerRegisteredUserCount": 5,
"kindlyInviteeUserCount": 2
}