Difference between revisions of "Upload Group Picture"
Ashley DeBon (talk | contribs) (→Update Group Tile Icon) |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| 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 | | 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 | ||
|} | |} | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/group-tile-icon' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --form 'group_id="YOUR_GROUP_ID"' \ --form 'group_image=@"/path/to/your/group-image.jpg"' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/group-tile-icon' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --form 'group_id="YOUR_GROUP_ID"' \ --form 'group_image=@"/path/to/your/group-image.jpg"' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 13:46, 21 July 2026
Contents
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
|
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/group-tile-icon' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --form 'group_id="YOUR_GROUP_ID"' \ --form 'group_image=@"/path/to/your/group-image.jpg"'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/group-tile-icon' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --form 'group_id="YOUR_GROUP_ID"' \ --form 'group_image=@"/path/to/your/group-image.jpg"'
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 invalidgroup_imagetype/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.
