Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Deeplinks

Create a deeplink

Required scope: deeplinks:write </br>Organization authorization: supported

post/api/v1/deeplinks

Request body

destinationType'link' | 'resource' required
commentstring nullable

Optional comment for the deeplink

operatorIdinteger nullable

The ID of the operator for whom the deeplink will be created. If not provided, operator ID will be derived from the used api credentials

Example request

{
  "destination": {
    "url": "https://example.com"
  },
  "comment": "Marketing campaign link",
  "operatorId": 123
}

Response

Deeplink created

idinteger

Unique identifier of the deeplink

destinationType'link' | 'resource' required
commentstring nullable

Optional comment for the deeplink

visitsinteger

Number of visits to this deeplink

operatorIdinteger

ID of the operator who created the deeplink

qrCodeUrlstring nullable

URL to the QR code image

appUrlstring nullable

Optional URL for the mobile app

createdAtstring required

Creation timestamp

updatedAtstring required

Last update timestamp

deletedAtstring nullable

Deletion timestamp, if deleted

Example response

{
  "id": 1,
  "destination": {
    "url": "https://example.com"
  },
  "comment": "Marketing campaign link",
  "visits": 42,
  "operatorId": 123,
  "qrCodeUrl": "https://example.com/qr/abc123",
  "appUrl": "monta://deeplink/abc123",
  "createdAt": "2024-01-01T12:00:00Z",
  "updatedAt": "2024-01-01T12:00:00Z",
  "deletedAt": "2024-01-01T12:00:00Z"
}