Global app settings
Global app settings allow you to centrally configure options affecting the behavior of Teamwire client applications on all platforms.
Manage Teamwire global app settings
Return global app settings
GET /v<api_version>/admin/globalappsettings/<organisation_id>/
Access restrictions
- Admins and Superadmins must have the allow_view_settings permission.
- Admins can request global app settings of their own organisation only.
- Superadmins can request global app settings of any organisation.
URL parameters
The following parameters are specified as part of the URL, i.e. /<parameter>/:
| Name | Type | Optional | For use by | Description |
|---|---|---|---|---|
| api_version | String | No | All admins | The Enterprise API version targeted. |
| organisation_id | Number | Yes | All admins | The ID of the organisation to retrieve the global app settings for. |
Result
The following return values indicate the outcome of the API call:
| HTTP status code | Description |
|---|---|
| 200 (OK) | The request was successful. Global app settings are returned as a JSON object as described below. |
| 401 (Unauthorized) | The request failed because the caller failed to first login to the Enterprise API or her session expired. Login to obtain a new session and repeat the request. |
| 403 (Forbidden) | The request failed because either a.) the calling admin’s organisation has been disabled or b.) an organisation ID was specified and the calling admin is not a Superadmin. |
| 404 (Not found) | The request failed because the organisation could not be found or organisation is from different backend federation. |
| 409 (Conflict) | The request failed because the organisation has been disabled. |
If the request was successful, a single JSON object with the following elements is returned:
| Name | Type | Visible to | Description |
|---|---|---|---|
app_color |
String | All admins | Application colour as hex code (e.g. #CAFEDE). |
logo |
Boolean | All admins | Whether a logo has been configured or not. |
logo_updated_at |
String | All admins | A timestamp indicating when the logo was last updated. |
allow_disable_read_receipts |
Boolean | All admins | Whether users are allowed to disable sending read receipts. |
max_chat_members |
Integer | All admins | Informs client about max allowd users per chat. |
Set global app settings
PUT /v<api_version>/admin/globalappsettings/<organisation_id>/
Access restrictions
- Admins and Superadmins must have the allow_modify_aettings permission.
- Admins can update global app settings of their own organisation only.
- Superadmins can update global app settings of any organisation.
URL parameters
The following parameters are specified as part of the URL, i.e. /<parameter>/:
| Name | Type | Optional | For use by | Description |
|---|---|---|---|---|
| api_version | String | No | All admins | The Enterprise API version targeted. |
| organisation_id | Number | Yes | All admins | The ID of the organisation to set the global app settings for. |
PUT data
Parameters are supplied as a JSON object with the following elements:
| Name | Type | Visible to | Description |
|---|---|---|---|
app_color |
String | All admins | Application colour as hex code (e.g. #CAFEDE). |
allow_disable_read_receipts |
Boolean | All admins | Whether users are allowed to disable sending read receipts. |
max_chat_members |
Integer | All admins | Informs client about max allowd users per chat. |
Result
The following return values indicate the outcome of the API call:
| HTTP status code | Description |
|---|---|
| 200 (OK) | The request was successful. The updated global app settings are returned as a JSON object as described for the GET request. |
| 400 (Bad Request) | The request failed because of invalid params. |
| 401 (Unauthorized) | The request failed because the caller failed to first login to the Enterprise API or her session expired. Login to obtain a new session and repeat the request. |
| 403 (Forbidden) | The request failed because a.) the calling admin’s organisation has been disabled or b.) an organisation ID was specified and the calling admin is not a Superadmin. |
| 404 (Not found) | The request failed because the organisation could not be found or organisation is from different backend federation. |
| 409 (Conflict) | The request failed because the organisation has been disabled. |