/members

API end-point to add or delete members from conversation groups inside Kaizala.

GET /members

GET {endpoint-url}/v1/groups/{groupId}/members

Request Parameters

Parameter Type Optional? Description
URL Path Parameter groupId String No GUID representing the groupId of the specific group resource
HTTP Header accessToken String No Access Token received from the auth end-point

Response body

Parameter Type Description
members JSON Array Array of JSON objects each representing a member of the group

Sample JSON Response

{
  "members": [
    {
      "id": "4deffa08-guid-4b87-8c2f-d944565f5f31",
      "role": "Admin",
      "mobileNumber": "+919652000000",
      "isProvisioned": true
    },
    {
      "id": "2e20e9ac-guid-47bd-abac-1f5236004684",
      "role": "Member",
      "mobileNumber": "+919652000001",
      "isProvisioned": false
    }
  ]
}

PUT /members

PUT {endpoint-url}/v1/groups/{groupId}/members

Request Parameters

Parameter Type Optional? Description
URL Path Parameter groupId String No GUID representing the groupId of the specific group resource
HTTP Header accessToken String No Access Token received from the auth end-point
HTTP Header Content-Type String No value: application/json

Request body

Parameter Type Description
members String Array Array of well-formatted phone numbers of new members to be added

Sample JSON Request

{
  "members": [
      "+91000000000",
      "+91900000000"
  ]
}

Response body

Parameter Type Description
result Boolean True when all phone numbers have successfully been added to the group

Sample JSON Response

{
    "result": "true"
}

DELETE /members

DELETE {endpoint-url}/v1/groups/{groupId}/members/{memberId}

Request Parameters

Parameter Type Optional? Description
URL Path Parameter groupId String No GUID representing the groupId of the specific group resource
URL Path Parameter memberId String No GUID representing the memberId of the specific member
HTTP Header accessToken String No Access Token received from the auth end-point

Response body

Parameter Type Description
result Boolean True when the specified member has successfully been removed from the group

Sample JSON Response

{
    "result": "true"
}