Links Management
The Links API is the core of the Apliko Link service. Use these endpoints to programmatically create, retrieve, update, and delete the deep links for your applications.
Base URL
https://api.apliko.linkThe Link Object
The Link object is the central resource in the Links API. It contains all the information needed to configure, track, and redirect a deep link. All API actions for links revolve around creating and managing these objects.
Attributes
| ATTRIBUTE | TYPE | DESCRIPTION |
|---|---|---|
id | string | A unique identifier (UUID v4) for the link, generated upon creation. |
projectId | string | The unique identifier (UUID v4) of the project to which this link belongs. |
type | string | The type of the link. Can be either DEEPLINK or SHORTLINK. |
shortCode | string | The unique, user-friendly short code that identifies the link (e.g., promo2025 in example.nvgt.link/promo2025). |
redirectUrl | string | The primary target URL (URI format) where the user should be redirected. This also acts as a fallback if the app cannot be opened. |
redirectToStore | boolean | If true, the user will be sent to the appropriate app store if the app is not installed. Defaults to true. |
socialTitle | string | The title for the rich preview when sharing the link on social media platforms. |
socialDescription | string | The description for the rich preview on social media. |
socialImageLink | string | A URL (URI format) to an image that will be used in the social media rich preview. |
metadata | object | A flexible object for key-value pairs to store any custom data. This data is passed through the deep link and can be retrieved in your application post-redirection, perfect for tracking campaigns or passing custom state. |
domainUriPrefix | string | The full URI prefix for the domain used in the deep link (e.g., https://example.nvgt.link). |
expiresAt | string | An optional ISO 8601 timestamp for when the link should expire and no longer be active. |
createdAt | string | The ISO 8601 timestamp indicating when the link was created. |
updatedAt | string | The ISO 8601 timestamp for when the link was last updated. |
Create a Link
This endpoint creates a new deep link or short link associated with your project. You must provide the essential routing information, such as the redirectUrl and domainUriPrefix. You can also include optional parameters to control social sharing previews, expiration, and custom metadata.
Request Body
Body Parameters
* Required| PARAMETER | TYPE | DESCRIPTION |
|---|---|---|
type* | string | Enum: "DEEPLINK", "SHORTLINK". |
redirectUrl* | string | The target URL to redirect to. |
domainUriPrefix* | string | Your link domain (e.g., https://example.nvgt.link). |
shortCode | string | Optional custom short code (3-20 characters). Auto-generated if omitted. |
redirectToStore | boolean | Redirect to App/Play Store if app not installed. Defaults to true. |
socialTitle | string | Title for social media sharing cards. |
socialDescription | string | Description for social media cards. |
socialImageLink | string | Image URL for social media cards. |
metadata | object | Key-value data for tracking. |
expiresAt | string | Optional expiration date in ISO 8601 format. |
Example Request
{
"type": "DEEPLINK",
"redirectUrl": "myapp://product/123",
"domainUriPrefix": "https://example.nvgt.link",
"shortCode": "promo2025",
"redirectToStore": true,
"socialTitle": "Special Product Offer",
"socialDescription": "Check out this amazing product and get 20% off!",
"socialImageLink": "https://images.example.com/product-123.png",
"metadata": {
"campaign": "summer_sale",
"source": "email_blast"
},
"expiresAt": "2025-12-31T23:59:59Z"
}Returns
If the request is successful, it returns the complete Link object with a 201 Created status code. If the request fails, it will return an appropriate error status code and message.
Retrieve a Link
Fetches the full details of a specific link by providing its unique ID. This is useful for inspecting a link's configuration or for programmatic management.
Path Parameters
Path Parameters
* Required| PARAMETER | TYPE | DESCRIPTION |
|---|---|---|
id* | string | The unique identifier (UUID) for the link. |
Returns
Returns a single Link object if a link with the given ID is found. If no link exists with that ID, this request returns a 404 Not Found error.
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"projectId": "2f3c1d76-4b55-4b5d-b8c0-6e122b8d9012",
"type": "DEEPLINK",
"shortCode": "promo2025",
"redirectUrl": "myapp://product/123",
"redirectToStore": true,
"socialTitle": "Special Product Offer",
"socialDescription": "Check out this amazing product and get 20% off!",
"socialImageLink": "https://images.example.com/product-123.png",
"metadata": {
"campaign": "summer_sale",
"source": "email_blast"
},
"domainUriPrefix": "https://example.nvgt.link",
"expiresAt": "2025-12-31T23:59:59.000Z",
"createdAt": "2024-08-01T10:00:00.000Z",
"updatedAt": "2024-08-01T10:00:00.000Z"
}List all Links
Returns a paginated list of all links associated with your project. The links are returned sorted by creation date, with the most recently created links appearing first. You can use the limit and offset parameters to control the pagination of the results.
Query Parameters
Query Parameters
| PARAMETER | TYPE | DESCRIPTION |
|---|---|---|
limit | number | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
offset | number | Number of items to skip for pagination. |
Returns
Returns an object containing a data property, which is an array of Link objects. The object may also include pagination details.
Update a Link
Updates the specified link by setting the values of the parameters passed in the request body. Any parameters not provided in the request will be left unchanged. This allows for partial updates to a link's configuration.
Path Parameters
Path Parameters
* Required| PARAMETER | TYPE | DESCRIPTION |
|---|---|---|
id* | string | The unique identifier (UUID) of the link to update. |
Request Body
The request body can include any of the writable parameters from the Create a Link action. You only need to provide the fields you wish to change.
Returns
Returns the complete, updated Link object if the update is successful. If the link cannot be found, it will return a 404 Not Found error.
Delete a Link
Permanently deletes a link by its unique ID. This action is irreversible and the link will no longer be accessible or functional. Use with caution.
Path Parameters
Path Parameters
* Required| PARAMETER | TYPE | DESCRIPTION |
|---|---|---|
id* | string | The unique identifier (UUID) of the link to delete. |
Returns
Returns a 204 No Content status code on successful deletion, with an empty response body. If the link does not exist, it will return a 404 Not Found error.