configureDeepLink
TenantDeepLinkSettingsWrapper configureDeepLink(DeepLinkConfigurationRequestDto)
POST /api/2.0/settings/deeplink
Configure the deep link settings
Sets how the portal responds when a client opens a DocSpace link on a mobile device: always in the browser, always in the native app, or asking the user to choose each time. Requires Owner or DocSpaceAdmin (the EditPortalSettings permission). The handling mode must be one of the documented enum values; anything else is rejected without being saved. This is a mutating, idempotent call: sending the same mode again leaves the setting unchanged. It returns the saved deep link settings, including the timestamp of the last change; read the current value at any time, including anonymously, from GET api/2.0/settings/deeplink.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| DeepLinkConfigurationRequestDto | body | DeepLinkConfigurationRequestDto | [optional] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | Saved deep link handling settings | TenantDeepLinkSettingsWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | The handling mode is not one of the supported deep link handling values | - | - |
| 403 | The caller has no portal-settings right | - | - |
| 500 | The request body has no deepLinkSettings | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: application/json
- Accept: application/json