---
title: "Create Short Link URL"
method: POST
path: "/link/short"
tags: ["Link"]
---

# Create Short Link URL

`POST /link/short`

Create a short URL for the Link onboarding flow as an alternative to the full Link URL with all its query parameters.

The response contains an 8-character `code` and the full `url` to share with your user. Short links are valid for 1 year from creation.

Identical request bodies are de-duplicated automatically. Calling this endpoint a second time with the same parameters returns the original short link with an `Idempotent-Replayed: true` response header.

## Request body

- object
  - `provider` string — Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under [provider details](/providers).
  - `providerHints` string[] — An optional list of provider codes to hoist to the top of the Link provider list.
  - `externalId` string — An optional ID from your system that can be used to reference connections.
  - `name` string — An optional human-readable name to associate with the resulting connection.
  - `tags` string[] — An optional list of tags from your system that can be used to reference connections.
  - `redirectUrl` string, uri — URL to redirect your user to after they complete the Link flow.
  - `syncMode` 'automatic' | 'manual' — Enum values: - `automatic`: Terminal will keep this connections data up to date - `manual`: Terminal will only sync data upon request
  - `backfill` object — Optional backfill to be requested upon successful connection. Will start from NOW if not provided.
    - `startFrom` string, date-time — [ISO 8601](https://www.w3.org/TR/NOTE-datetime) date
    - `days` number
  - `template` string, ulid — Unique identifier for the Link Template.

## Response `200`

OK

- object — A short URL for the Link onboarding flow. The associated parameters are stored at creation time and retrieved when your user visits the URL.
  - `id` string, ulid, required — Durable identifier for the short link resource.
  - `code` string, required — 8-character code that is associated with the original Link parameters.
  - `url` string, uri, required — Full short URL to share with your user.
  - `expiresAt` string, date-time, required — [ISO 8601](https://www.w3.org/TR/NOTE-datetime) date

## Other responses

- `201` — Created
- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests
- `500` — Internal Server Error
- `504` — Gateway Timeout Error

---

[API](https://skmtc.dev/withterminal/apis/terminal-telematics-api.md) · [All operations](https://skmtc.dev/withterminal/apis/terminal-telematics-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/withterminal/terminal-telematics-api/revisions/90249c4a1739/schema)