api/v1/customer/messages/{id}/remove-member

POST

/api/v1/customer/messages/{id}/remove-member

This API method allows you to remove members in a chat group. You are only able to remove a customer if you are the initial group creator.

Request Parameters

Parameter	Value / Type	Required
customer_list	STRING / ARRAY	true

Sample Response

{
  "status": true,
  "message": "Successfully removed member(s) from the chat group",
  "group_name": "Steve Phillips, John Doe, 1 Blocked User"
}

{
    "status": false,
    "errorCode": "VALIDATION_EXCEPTION",
    "messages": {
        "id": [
            "Message Group does not exist"
        ]
    }
}

{
    "status": false,
    "message": "Cannot remove member as you are not the group creator"
}

{
    "status": false,
    "message": "Already removed member(s) from the chat group"
}

{
    "status": false,
    "message": "No members could be removed, most likely they are already removed from the group"
}

{
  "status": false,
  "message": "Some of the members added were invalid and may not exist"
}