App configuration

Threema Work allows to remotely edit app settings. You can control the app’s configuration, disable specific features, and the end user is relieved from setting up the app manually.

Configuration via MDM software

If you don’t use an MDM system for the app’s deployment, Threema MDM is a convenient way of controlling the app’s settings in the management cockpit. With Threema MDM, the same parameters that are available when using a regular MDM system can be configured. Learn more…

Configuration via MDM software

On Android and iOS, apps can be installed in a Managed Profile to separate personal and professional use. Apps that are installed this way can be remotely configured using an MDM system.

Threema Work supports the following platforms and profile types:

Platform
System requirement
Supported profile type
PlatformAndroid
System requirementAndroid 5.0+
Supported profile typeAndroid Enterprise / Managed Configurations
PlatformiOS
System requirementiOS 7+
Supported profile typeManaged App Configuration

To ensure compatibility, please contact the developer of your MDM system.

Configuration parameters

Name
Type
Min
Max
OS
Renewable1
User-editable2
Default value

User Management

th_license_username
Username required to activate the app (requires an external MDM system and is not available in Threema MDM)
Type:string
Min:1
Max:255
OS:All
Renewable:No
User-editable:No
Default value:-
Username required to activate the app (requires an external MDM system and is not available in Threema MDM)
th_license_password
Password required to activate the app (requires an external MDM system and is not available in Threema MDM)
Type:string
Min:1
Max:-
OS:All
Renewable:No
User-editable:No
Default value:-
Password required to activate the app (requires an external MDM system and is not available in Threema MDM)
th_csi
CSI (Customer Specific Identifier) can be any value (e.g., an internal employee reference); this value is only visible in the management cockpit, not in the app.
Type:string
Min:-
Max:255
OS:Android (3.43k)
iOS (3.0.9k)
Renewable:Yes
User-editable:No
Default value:-
CSI (Customer Specific Identifier) can be any value (e.g., an internal employee reference); this value is only visible in the management cockpit, not in the app.
th_category
User category (e.g. group, department); visible in management cockpit and API.
Type:string
Min:-
Max:255
OS:Android (3.43k)
iOS (3.0.9k)
Renewable:Yes
User-editable:No
Default value:-
User category (e.g. group, department); visible in management cockpit and API.
th_skip_wizard
If set to true, the setup wizard that would show up on the first app launch is skipped. (In the setup wizard, the parameters th_linked_phone, th_linked_email, and th_contact_sync as well as parameters for Threema Safe can be defined.)
Type:bool
Min:-
Max:-
OS:Android (3.2k)
iOS (3.0.6k)
Renewable:Yes
User-editable:No
Default value:-
If set to true, the setup wizard that would show up on the first app launch is skipped. (In the setup wizard, the parameters th_linked_phone, th_linked_email, and th_contact_sync as well as parameters for Threema Safe can be defined.)

User Profile

th_nickname
The nickname appears in the contact details (as well as in push notifications).
Type:string
Min:-
Max:32
OS:All
Renewable:Yes
User-editable:Yes
Default value:-
The nickname appears in the contact details (as well as in push notifications).
th_linked_email
The email address linked to a Threema ID is used for contact synchronization.
Type:string
Min:-
Max:-
OS:All
Renewable:No
User-editable:Yes
Default value:-
The email address linked to a Threema ID is used for contact synchronization.
th_linked_phone
The phone number linked to a Threema ID is used for contact synchronization; it must be specified in international format, e.g., +41555114900.
Type:string
Min:-
Max:-
OS:All
Renewable:No
User-editable:Yes
Default value:-
The phone number linked to a Threema ID is used for contact synchronization; it must be specified in international format, e.g., +41555114900.
th_readonly_profile
If set to true, the user cannot change the following profile settings: nickname, profile picture, email address / phone number linked to the ID, export ID, delete ID, ID revocation password. The use of Threema Safe and the export of the Threema ID can be prevented using the parameters th_safe_enable and th_disable_id_export, respectively.
Type:bool
Min:-
Max:-
OS:All
Renewable:Yes
User-editable:No
Default value:-
If set to true, the user cannot change the following profile settings: nickname, profile picture, email address / phone number linked to the ID, export ID, delete ID, ID revocation password. The use of Threema Safe and the export of the Threema ID can be prevented using the parameters th_safe_enable and th_disable_id_export, respectively.
th_disable_id_export
If set to true, the user cannot export their ID.
Type:bool
Min:-
Max:-
OS:Android (3.7k)
iOS (4.2.1k)
Renewable:Yes
User-editable:No
Default value:-
If set to true, the user cannot export their ID.
th_disable_send_profile_picture
If set to true, the user’s profile picture will not be shared with others.
Type:bool
Min:-
Max:-
OS:Android (3.14k)
iOS (2.10.1k)
Renewable:Yes
User-editable:No
Default value:-
If set to true, the user’s profile picture will not be shared with others.

Contacts

th_firstname
First name of the user; visible in management cockpit and API.
Type:string
Min:-
Max:255
OS:Android (3.43k)
iOS (3.0.9k)
Renewable:Yes
User-editable:No
Default value:-
First name of the user; visible in management cockpit and API.
th_lastname
Last name of the user; visible in management cockpit and API.
Type:string
Min:-
Max:255
OS:Android (3.43k)
iOS (3.0.9k)
Renewable:Yes
User-editable:No
Default value:-
Last name of the user; visible in management cockpit and API.
th_contact_sync
If set to true, synchronization with the local address book is enabled. On Android as well as in earlier versions (<4.5k) of the iOS app, this parameter is not renewable.
Type:bool
Min:-
Max:-
OS:All
Renewable:Yes
User-editable:No
Default value:-
If set to true, synchronization with the local address book is enabled. On Android as well as in earlier versions (<4.5k) of the iOS app, this parameter is not renewable.
th_block_unknown
If set to true, unknown contacts (i.e., contacts not contained in the device's contact list) are blocked.
Type:bool
Min:-
Max:-
OS:All
Renewable:Yes
User-editable:No
Default value:-
If set to true, unknown contacts (i.e., contacts not contained in the device's contact list) are blocked.
th_disable_add_contact
If set to true, the user cannot manually add contacts. Contacts can only be added via contact synchronization (if not disabled; see th_contact_sync) or by receiving messages from unknown contacts (if not disabled; see th_block_unknown).
Type:bool
Min:-
Max:-
OS:Android (2.82k)
iOS (2.7.3k)
Renewable:Yes
User-editable:No
Default value:-
If set to true, the user cannot manually add contacts. Contacts can only be added via contact synchronization (if not disabled; see th_contact_sync) or by receiving messages from unknown contacts (if not disabled; see th_block_unknown).
th_disable_work_directory
If set to true, access to the internal Threema Work user directory is denied.
Type:bool
Min:-
Max:-
OS:Android (4.55k)
iOS (4.6.9k)
Renewable:Yes
User-editable:No
Default value:-
If set to true, access to the internal Threema Work user directory is denied.

Backup: General

th_id_backup
This parameter is used to pass precalculated key pairs (Threema IDs) and restore ID backups. This parameter is deprecated, please use th_safe_restore_id instead.
Type:string
Min:99
Max:99
OS:All
Renewable:No
User-editable:No
Default value:-
This parameter is used to pass precalculated key pairs (Threema IDs) and restore ID backups. This parameter is deprecated, please use th_safe_restore_id instead.
th_id_backup_password
Password for ID backup in th_id_backup. This parameter is deprecated, please use th_safe_password instead.
Type:string
Min:8
Max:-
OS:All
Renewable:No
User-editable:No
Default value:-
Password for ID backup in th_id_backup. This parameter is deprecated, please use th_safe_password instead.
th_disable_backups
If set to true, the user cannot create any kind of backup. This parameter overrides th_safe_enable, th_disable_data_backups, th_disable_system_backups and th_disable_id_export.
Type:bool
Min:-
Max:-
OS:All
Renewable:Yes
User-editable:No
Default value:-
If set to true, the user cannot create any kind of backup. This parameter overrides th_safe_enable, th_disable_data_backups, th_disable_system_backups and th_disable_id_export.
th_disable_data_backups
If set to true, the user cannot create data backups (only available on Android).
Type:bool
Min:-
Max:-
OS:Android (3.7k)
Renewable:Yes
User-editable:No
Default value:-
If set to true, the user cannot create data backups (only available on Android).
th_disable_system_backups
If set to true, Threema data is excluded from iTunes/iCloud backups. Not relevant for Android.
Type:bool
Min:-
Max:-
OS:iOS (4.2.1k)
Renewable:Yes
User-editable:No
Default value:-
If set to true, Threema data is excluded from iTunes/iCloud backups. Not relevant for Android.

Backup: Threema Safe

th_safe_enable
If set to true, Threema Safe must be used; if set to false, Threema Safe cannot be used. (If not set at all, Threema Safe can be used.)
Type:bool
Min:-
Max:-
OS:Android (3.62k)
iOS (4.2.1k)
Renewable:Yes
User-editable:No
Default value:-
If set to true, Threema Safe must be used; if set to false, Threema Safe cannot be used. (If not set at all, Threema Safe can be used.)
th_safe_password
Password to encrypt (or restore, cf. th_safe_restore_id ) Threema Safe backup (requires an external MDM system and is not available in Threema MDM)
Type:string
Min:8
Max:4096
OS:Android (3.62k)
iOS (4.2.1k)
Renewable:Yes
User-editable:No
Default value:-
Password to encrypt (or restore, cf. th_safe_restore_id ) Threema Safe backup (requires an external MDM system and is not available in Threema MDM)
th_safe_server_url
URL for custom Threema Safe server, e.g., examplecompany.com/threemasafe
Type:string
Min:-
Max:-
OS:Android (3.62k)
iOS (4.2.1k)
Renewable:Yes
User-editable:No
Default value:-
URL for custom Threema Safe server, e.g., examplecompany.com/threemasafe
th_safe_server_username
Username for HTTPS authentication of Threema Safe server defined in th_safe_server_url (if required)
Type:string
Min:-
Max:-
OS:Android (3.62k)
iOS (4.2.1k)
Renewable:Yes
User-editable:No
Default value:-
Username for HTTPS authentication of Threema Safe server defined in th_safe_server_url (if required)
th_safe_server_password
Password for HTTPS authentication of Threema Safe server defined in th_safe_server_url (if required)
Type:string
Min:-
Max:-
OS:Android (3.62k)
iOS (4.2.1k)
Renewable:Yes
User-editable:No
Default value:-
Password for HTTPS authentication of Threema Safe server defined in th_safe_server_url (if required)
th_safe_restore_enable
If set to false, Threema Safe backups cannot be restored. If set to true, restoring a Threema Safe backup in the setup wizard is either optional (if th_safe_restore_id is not set) or mandatory (if th_safe_restore_id is set).
Type:bool
Min:-
Max:-
OS:Android (3.62k)
iOS (4.2.1k)
Renewable:No
User-editable:No
Default value:-
If set to false, Threema Safe backups cannot be restored. If set to true, restoring a Threema Safe backup in the setup wizard is either optional (if th_safe_restore_id is not set) or mandatory (if th_safe_restore_id is set).
th_safe_restore_id
Threema ID to restore from Threema Safe if th_safe_restore_enable is true. If th_safe_password is also set, the ID is restored without user interaction.
Type:string
Min:8
Max:8
OS:Android (3.62k)
iOS (4.2.1k)
Renewable:No
User-editable:No
Default value:-
Threema ID to restore from Threema Safe if th_safe_restore_enable is true. If th_safe_password is also set, the ID is restored without user interaction.
th_safe_password_pattern
Regular Expression (Regex) that defines the format of the password chosen by the user for Threema Safe. If not set, only a minimum length of 8 characters is enforced. The regular expression must be compatible with Java Pattern (Android) and NSRegularExpression (iOS).
Type:string
Min:-
Max:-
OS:Android (4.2k)
iOS (4.4k)
Renewable:Yes
User-editable:No
Default value:-
Regular Expression (Regex) that defines the format of the password chosen by the user for Threema Safe. If not set, only a minimum length of 8 characters is enforced. The regular expression must be compatible with Java Pattern (Android) and NSRegularExpression (iOS).
th_safe_password_message
Error message that is shown if the password that the user has chosen for Threema Safe does not match the pattern in th_safe_password_pattern.
Type:string
Min:-
Max:-
OS:Android (4.2k)
iOS (4.4k)
Renewable:Yes
User-editable:No
Default value:-
Error message that is shown if the password that the user has chosen for Threema Safe does not match the pattern in th_safe_password_pattern.
th_hide_inactive_ids
If set to true, inactive IDs (i.e., IDs that have not been in use for at least three months) and revoked IDs are hidden.
Type:bool
Min:-
Max:-
OS:Android (4.2k)
iOS (4.4k)
Renewable:Yes
User-editable:No
Default value:-
If set to true, inactive IDs (i.e., IDs that have not been in use for at least three months) and revoked IDs are hidden.
th_disable_share_media
If set to true, saving and sharing media and other files outside of Threema Work is prevented. On Android, this only applies to images, videos, and voice messages (for OS-specific reasons). For technical reasons, saving and sharing media and other files using Threema Web is still possible (unless th_disable_web is set to true).
Type:bool
Min:-
Max:-
OS:Android (4.2k)
iOS (4.4k)
Renewable:Yes
User-editable:No
Default value:-
If set to true, saving and sharing media and other files outside of Threema Work is prevented. On Android, this only applies to images, videos, and voice messages (for OS-specific reasons). For technical reasons, saving and sharing media and other files using Threema Web is still possible (unless th_disable_web is set to true).

Chat and Calls

If set to true, media files will not be auto-saved to the local gallery.
th_disable_screenshots
If set to true, the user cannot take screenshots on Android, and no thumbnail is displayed in Android’s app switcher.
Type:bool
Min:-
Max:-
OS:Android
Renewable:Yes
User-editable:No
Default value:-
If set to true, the user cannot take screenshots on Android, and no thumbnail is displayed in Android’s app switcher.
th_disable_export
If set to true, the user cannot export chats.
Type:bool
Min:-
Max:-
OS:All
Renewable:Yes
User-editable:No
Default value:-
If set to true, the user cannot export chats.
th_disable_message_preview
If set to true, the message preview in push notifications is disabled.
Type:bool
Min:-
Max:-
OS:Android (3.02k)
iOS (2.9.1k)
Renewable:Yes
User-editable:No
Default value:-
If set to true, the message preview in push notifications is disabled.
th_disable_calls
If set to true, Threema calls (both voice and video calls) are disabled.
Type:bool
Min:-
Max:-
OS:Android (3.2k)
iOS (3.0k)
Renewable:Yes
User-editable:No
Default value:-
If set to true, Threema calls (both voice and video calls) are disabled.
th_disable_video_calls
If set to true, Threema video calls are disabled. Quality settings remain editable.
Type:bool
Min:-
Max:-
OS:Android (4.41k)
iOS (4.6.1k)
Renewable:Yes
User-editable:No
Default value:-
If set to true, Threema video calls are disabled. Quality settings remain editable.
th_disable_create_group
If set to true, the user cannot create groups.
Type:bool
Min:-
Max:-
OS:Android (3.3k)
iOS (3.0.4k)
Renewable:Yes
User-editable:No
Default value:-
If set to true, the user cannot create groups.
th_disable_web
If set to true, Threema Web is disabled.
Type:bool
Min:-
Max:-
OS:Android (3.551k)
iOS (4.0.3k)
Renewable:Yes
User-editable:No
Default value:-
If set to true, Threema Web is disabled.
th_web_hosts
If set, Threema Web can only connect to the defined servers. As value, a comma-separated list of hostnames is expected. If a hostname starts with *, suffix matching is applied, in the other case, the hostname must match completely. Example: signaling.threema.ch,*-signaling-test.threema.ch
Type:string
Min:-
Max:-
OS:Android (4.1k)
iOS (4.4k)
Renewable:Yes
User-editable:No
Default value:-
If set, Threema Web can only connect to the defined servers. As value, a comma-separated list of hostnames is expected. If a hostname starts with *, suffix matching is applied, in the other case, the hostname must match completely. Example: signaling.threema.ch,*-signaling-test.threema.ch

1 Renewable

Yes: If you change this value, it will take up to 24 hours until the change becomes effective on the users’ end (users can pull down the contact list in the app to manually force a synchronization and get the most current values). Please note that in order for the parameters th_safe_password, th_safe_server_url, th_safe_server_username and th_safe_server_password to be renewed, the app must be restarted.

No: This value is set when users license the app. For users who have completed the setup process, a change to this value will only become effective if they reinstall the app or generate a new ID.

2 User-editable

Yes: Unless th_readonly_profile is true, the setting corresponding to this value can be changed by users in the app.

No: The setting corresponding to this value cannot be changed by users in the app if a value is set via MDM.