Upload Group Picture - Revision history

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

2026-07-21T13:46:15Z

‎Successful Response (200)

Ashley DeBon: /* Update Group Tile Icon */

2026-07-21T13:45:46Z

‎Update Group Tile Icon

Ashley DeBon: Created page with "== Update Group Tile Icon == === Base URL === https://apimobile.callproof.com === Endpoint === /api/group-tile-icon === Purpose === Uploads and updates the tile icon image..."

2026-07-21T13:45:35Z

Created page with "== Update Group Tile Icon == === Base URL === https://apimobile.callproof.com === Endpoint === /api/group-tile-icon === Purpose === Uploads and updates the tile icon image..."

New page

== Update Group Tile Icon ==

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

=== Endpoint ===
/api/group-tile-icon

=== Purpose ===
Uploads and updates the tile icon image for a video message group. For cross-company groups, the icon is stored under the group’s company.

=== HTTP Method ===
POST

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|-
| Content-Type || Yes || <code>multipart/form-data</code> (file upload)
|}

=== 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 (room) whose icon will be updated
|-
| group_image || file || Yes* || Group icon image (jpeg/png/jpg; minimum size rule <code>min:5</code>). *Required for a successful update; if missing, the API returns an error
|}

=== Successful Response (200) ===
Indicates that the group tile icon was updated successfully.

{| class="wikitable"
! Field !! Type !! Description
|-
| clientStatusCode || integer || Status indicator for the client (for example, 200)
|-
| user_id || integer || Identifier of the authenticated user
|-
| company_id || integer || Identifier of the authenticated user’s company
|-
| message || string || Confirmation message (for example, "Group tile Icon updated successfully")
|-
| uri || string || Requested resource URI
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 200 || Validation failed – response body uses <code>clientStatusCode</code> 401 with the first validation error message
|-
| 400 || Bad Request – the group icon could not be updated
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''Validation (HTTP 200, clientStatusCode 401)''' – Missing <code>group_id</code>, or invalid <code>group_image</code> type/format/size.
* '''400''' – Image not uploaded ("Image not uploaded"), upload failure ("Error while uploading the group tile icon"), or another processing error.
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 13:45, 21 July 2026
Line 1:		Line 1:
−	== Update Group Tile Icon ==	+	== [[Mobile_API]] »Update Group Tile Icon ==

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

@@ Line 41: / Line 41: @@
 | group_image || file || Yes* || Group icon image (jpeg/png/jpg; minimum size rule <code>min:5</code>). *Required for a successful update; if missing, the API returns an error
 |}
 === Successful Response (200) ===