Leave Group - Revision history

Ashley DeBon: /* Successful Response (200) */

2026-07-21T13:44:00Z

‎Successful Response (200)

Ashley DeBon: /* Leave Group */

2026-07-21T13:43:28Z

‎Leave Group

Ashley DeBon: Created page with "== Leave Group == === Base URL === https://apimobile.callproof.com === Endpoint === /api/leave-group === Purpose === Removes a user from a video message group. By default,..."

2026-07-21T13:43:19Z

Created page with "== Leave Group == === Base URL === https://apimobile.callproof.com === Endpoint === /api/leave-group === Purpose === Removes a user from a video message group. By default,..."

New page

== Leave Group ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/leave-group

=== Purpose ===
Removes a user from a video message group. By default, the authenticated user leaves the group. If another <code>user_id</code> is provided, the authenticated user must be a group admin and that member is removed instead. If the departing user is the only admin and other members remain, another member is promoted to admin. If the last member leaves, the group is deleted.

=== HTTP Method ===
DELETE

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Path Parameters ====
None.

==== Query Parameters ====
None.

==== Request Body ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| group_id || integer || Yes || Unique identifier of the group to leave
|-
| user_id || integer || No || Member to remove from the group. When provided, the authenticated user must be a group admin. When omitted, the authenticated user leaves the group
|}

=== Successful Response (200) ===
Indicates that the member left (or was removed from) the group successfully.

{| class="wikitable"
! Field !! Type !! Description
|-
| clientStatusCode || integer || Status indicator for the client (for example, 200)
|-
| message || string || Confirmation message (for example, "Left the group successfully")
|-
| uri || string || Requested resource URI
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 200 || Validation/authorization failed – response body uses <code>clientStatusCode</code> 401
|-
| 400 || Bad Request – the leave/remove action could not be completed
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''Validation/authorization (HTTP 200, clientStatusCode 401)''' – Missing <code>group_id</code>, or the authenticated user is not a group admin when trying to remove another user (for example, "Login user as not an group admin of this group").
* '''400''' – An error occurred while leaving the group (for example, "Error while processing").
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 13:43, 21 July 2026
Line 1:		Line 1:
−	== Leave Group ==	+	== [[Mobile_API]] »Leave Group ==

	=== Base URL ===		=== Base URL ===

@@ Line 39: / Line 39: @@
 | user_id || integer || No || Member to remove from the group. When provided, the authenticated user must be a group admin. When omitted, the authenticated user leaves the group
 |}
 === Successful Response (200) ===