Group related

Group created in a Shift

Triggered whenever a Group is created in a Shift through the app.

Response Format

Returns a JSON object of the group data.

Field	Type	Required	Description	Format Allowed
kindlyPartnerGroupId	String	✔	Group's ID.	Any string value
kindlyShiftId	String	✔	Shift's ID.	Any string value
kindlyUserId	String	✔	The User ID of the Group Leader.	Any string value
partnerGroupName	String	✔	Group's Name. *Displayed in the app.	Any string value
partnerGroupType	Integer	✔	Group's Type.	An integer from 1 to 7 Learn more in Group Type enum
partnerGroupUserCount	Integer	✔	The maximum number of Volunteers that can join the Group.	Positive integer, greater than 0

Example Response Body

{
  "kindlyPartnerGroupId": "d223d859edae404290fc6d79a393aa24",
  "kindlyShiftId": "688afa4497bd44ba852f5c5673b365f8",
  "kindlyUserId":"2c03414c91fc42c28043528edecc4fca",
  "partnerGroupName": "The Cool Group",
  "partnerGroupType": 2,
  "partnerGroupUserCount": 15
}

---

Group removed from its Shift

Triggered whenever a Group is removed from its Shift through the app.

Response Format

Returns a JSON object of the removal data.

Field	Type	Required	Description	Format Allowed
kindlyPartnerGroupId	String	✔	Group's ID.	Any string value
kindlyShiftId	String	✔	Shift's ID.	Any string value

Example Response Body

{
  "kindlyPartnerGroupId": "d223d859edae404290fc6d79a393aa24",
  "kindlyShiftId": "e0b4a43800a24116ad269608ec0178d7"
}

---

Group details updated

Triggered whenever the details of a Group are updated through the app.

Response Format

Returns a JSON object of the group data.

Field	Type	Required	Description	Format Allowed
kindlyPartnerGroupId	String	✔	Group's ID.	Any string value
kindlyShiftId	String	✔	Shift's ID.	Any string value
kindlyUserId	String	✔	The User ID of the Group Leader.	Any string value
partnerGroupName	String	✔	Group's Name. *Displayed in the app.	Any string value
partnerGroupType	Integer	✔	Group's Type.	An integer from 1 to 7 Learn more in Group Type enum
partnerGroupUserCount	Integer	✔	The maximum number of Volunteers that can join the Group.	Positive integer, greater than 0

Example Response Body

{
  "kindlyPartnerGroupId": "d223d859edae404290fc6d79a393aa24",
  "kindlyShiftId": "688afa4497bd44ba852f5c5673b365f8",
  "kindlyUserId":"2c03414c91fc42c28043528edecc4fca",
  "partnerGroupName": "The Cool Group",
  "partnerGroupType": 2,
  "partnerGroupUserCount": 15
}

---

Invited Name added in a Group

Triggered whenever the Group Leader adds an Invited Name to the Group.

Response Format

Returns a JSON object of the added Invited Name.

Field	Type	Required	Description	Format Allowed
kindlyInvitationId	String	✔	Invited Name's ID.	Any string value
kindlyPartnerGroupId	String	✔	Group's ID.	Any string value
kindlyShiftId	String	✔	Shift's ID.	Any string value
firstName	String	✔	Invited Name's First Name.	Any string value
lastName	String	✔	Invited Name's Last Name.	Any string value
email	String	✔	Invited Name's Email Address.	Any string value
isMinor	Boolean	✔	Whether the Invited Name is a minor.	Any boolean value

Example Response Body

{
  "kindlyInvitationId":"2c03414c91fc42c28043528edecc4fca",
  "kindlyPartnerGroupId": "d223d859edae404290fc6d79a393aa24",
  "kindlyShiftId": "688afa4497bd44ba852f5c5673b365f8",
  "firstName": "John",
  "lastName": "Doe",
  "email": "johndoe@gmail.com",
  "isMinor": false
}

---

Invited Name removed from a Group

Triggered whenever the Group Leader removes an Invited Name from the Group.

Response Format

Returns a JSON object of the removed Invited Name.

Field	Type	Required	Description	Format Allowed
kindlyInvitationId	String	✔	Invited Name's ID.	Any string value

Example Response Body

{
  "kindlyInvitationId":"2c03414c91fc42c28043528edecc4fca"
}