Skip to main content
POST
Open a deep link
Opens a deep link on the device, e.g. myapp://profile/42 or an HTTPS app link such as https://example.com/item/7. On Android the link is dispatched as an intent. By default any app that handles the link can receive it (android.intent.action.VIEW); pass packageName to pin the intent to a specific app, or action to dispatch a different intent action. Requests targeting a protected package fail with 403 Forbidden. On iOS the URL is opened directly by the system. packageName and action are Android-only and fail with an unsupported-feature error when set; bundleId is reserved for targeting a specific iOS app and is not yet supported.

Authorizations

Authorization
string
header
required

Bearer token via Authorization header

Headers

X-Device-Display-ID
integer<int64>
default:0
Required range: x >= 0

Path Parameters

deviceId
string
required

Body

application/json

Deep link to open (e.g. myapp://path or https://example.com/path)

Minimum string length: 1
action
string

Android only: intent action to dispatch. Defaults to android.intent.action.VIEW.

bundleId
string

Reserved for targeting a specific iOS app; currently rejected as unsupported.

packageName
string

Android only: package to receive the intent (e.g. com.example.app). Omit to let the system pick the handler.

Response

No Content