Difference between revisions of "Upload Group Picture"

From docs
Jump to: navigation, search
(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...")
 
(Update Group Tile Icon)
Line 1: Line 1:
== Update Group Tile Icon ==
+
== [[Mobile_API]] »Update Group Tile Icon ==
  
 
=== Base URL ===
 
=== Base URL ===

Revision as of 13:45, 21 July 2026

Mobile_API »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

Header Required Description
Authorization Yes Bearer access token
Content-Type Yes multipart/form-data (file upload)

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

None.

Query Parameters

None.

Request Body

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 min:5). *Required for a successful update; if missing, the API returns an error

Successful Response (200)

Indicates that the group tile icon was updated successfully.

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

Status Code Meaning
200 Validation failed – response body uses clientStatusCode 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 group_id, or invalid group_image 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.