GroupRoomdelete
Revision as of 13:31, 21 July 2026 by Ashley DeBon (talk | contribs) (Created page with "== Delete Room Group == === Base URL === https://apimobile.callproof.com === Endpoint === /api/delete-room-group/{group_id} === Purpose === Deletes a video-message group ro...")
Contents
Delete Room Group
Base URL
https://apimobile.callproof.com
Endpoint
/api/delete-room-group/{group_id}
Purpose
Deletes a video-message group room. Only a group admin can delete the group, and the ID must refer to an existing group room.
HTTP Method
DELETE
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| group_id | integer | Yes | Unique identifier of the group room to delete |
Query Parameters
None.
Request Body
None.
Successful Response (200)
Indicates that the group room was deleted successfully.
| Field | Type | Description |
|---|---|---|
| clientStatusCode | integer | Status indicator for the client (for example, 200) |
| message | string | Confirmation message (for example, "Processed successfully.") |
| uri | string | Requested resource URI |
Error Responses
| Status Code | Meaning |
|---|---|
| 200 | Authorization/validation failed – response body uses clientStatusCode 401 with an error message
|
| 400 | Bad Request – the group could not be deleted |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- Validation/authorization (HTTP 200, clientStatusCode 401) – Group not found ("Group id not found"), or the authenticated user is not a group admin ("Group admin only have privileges to delete this group").
- 400 – An error occurred while deleting the group (for example, "Error while processing").
- 401 – Authentication failed or the access token is missing/expired.