---
title: "POST /v2/links"
method: POST
path: "/v2/links"
tags: ["Links"]
---

# POST /v2/links

`POST /v2/links`

## Request

- Base URL: `https://api.peer.xyz`
- URL: `https://api.peer.xyz/v2/links`
- Auth: API key in header `x-api-key`

## Request body

- object
  - `type` 'intent' | 'share' | 'referral' | 'generic'
  - `destinationPath` string
  - `queryParams` object
    - `referralCode` string
  - `clip` boolean
  - `privyId` string
  - `wallet` string
  - `metadata` object
    - `title` string
    - `description` string
    - `image` string
  - `shortCodeLength` integer
  - `uppercase` boolean

## Response `200`

Dynamic link created

- object
  - `success` boolean, required
  - `message` string, required
  - `responseObject` object
    - `link` object, required
      - `shortCode` string, required
      - `url` string, required
      - `destinationPath` string, required
      - `queryParams` object, nullable, required
  - `statusCode` number, required
  - `errorCode` string

## Changes

- **2026-09-06** `7cd8d7a3cfcd`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/peer/apis/swagger-api/changes/v2/links/post.md)

---

[API](https://skmtc.dev/peer/apis/swagger-api.md) - [All operations](https://skmtc.dev/peer/apis/swagger-api/llms.txt) - [OpenAPI document](https://skmtc.dev/peer/apis/swagger-api/revisions/ef91955315e2?raw)