Skip to content
Get Started

Public API

Deep links

On this page

Routes the SDK stores for notification taps.

These routes are the public API. Send Authorization: Bearer with a workspace server API key. The key can act on every app in the workspace. A route that names an app uses that app id. environment is development or production.

The deep links were found.

Path

  • app — App id in this workspace.
  • environment — development or production.

Responses

  • 200 DEEP_LINKS_FETCHED — The deep links were found.
    • links (array of object, required)
  • 401 INVALID_API_KEY — The API key is invalid.
  • 404 APP_NOT_FOUND — The app could not be found.
  • 429 RATE_LIMIT_EXCEEDED — Too many requests. Please try again later.
  • 500 SERVER_ERROR — Something went wrong. Please try again.

The deep links were saved.

Path

  • app — App id in this workspace.
  • environment — development or production.

Body

  • links (array of object, required) — The app routes to store. Replaces the list already stored for this app. Send an empty list to clear it. At most 50 routes.

Responses

  • 200 DEEP_LINKS_SAVED — The deep links were saved.
    • links (array of object, required)
  • 401 INVALID_API_KEY — The API key is invalid.
  • 404 APP_NOT_FOUND — The app could not be found.
  • 422 VALIDATION_FAILED — The request contains invalid fields.
  • 429 RATE_LIMIT_EXCEEDED — Too many requests. Please try again later.
  • 500 SERVER_ERROR — Something went wrong. Please try again.