---
title: "Add a link type"
method: POST
path: "/gs1/products/{product_id}/links/"
tags: ["GS1 Digital Link"]
---

# Add a link type

`POST /gs1/products/{product_id}/links/`

## Request

- Base URL: `https://hovercode.com/api/v2`
- URL: `https://hovercode.com/api/v2/gs1/products/{product_id}/links/`
- Auth: API key in header `Authorization`

Adds a destination for one link type. Exactly one link is the default; setting a new default unsets the others.

## Path parameters

- `product_id` string, uuid, required

## Request body

- GS1LinkCreate
  - `link_type` 'gs1:pip' | 'gs1:quickStartGuide' | 'gs1:instructions' | 'gs1:safetyInfo' | 'gs1:recipeInfo' | 'gs1:traceability' | 'gs1:hasRetailers' | 'gs1:recallStatus' | 'gs1:review' | 'gs1:ePIL' | 'gs1:productSustainabilityInfo' | 'gs1:promotion' | 'gs1:masterData' | 'gs1:smpc' | 'gs1:certificationInfo' | 'gs1:registerProduct', required
  - `title` string, required
  - `destination_url` string, required
  - `is_default` boolean
  - `language` string, nullable
  - `media_type` string, nullable

## Response `201`

Link created.

- GS1Link
  - `id` string, uuid, required
  - `link_type` 'gs1:pip' | 'gs1:quickStartGuide' | 'gs1:instructions' | 'gs1:safetyInfo' | 'gs1:recipeInfo' | 'gs1:traceability' | 'gs1:hasRetailers' | 'gs1:recallStatus' | 'gs1:review' | 'gs1:ePIL' | 'gs1:productSustainabilityInfo' | 'gs1:promotion' | 'gs1:masterData' | 'gs1:smpc' | 'gs1:certificationInfo' | 'gs1:registerProduct', required
  - `title` string, required
  - `destination_url` string, required
  - `is_default` boolean, required
  - `language` string, nullable
  - `media_type` string, nullable

## Other responses

- `400`: Validation error.
- `401`: Missing or invalid API token.
- `404`: Not found, or not in a workspace you belong to.
- `415`: Request body was not JSON.
- `429`: Rate limit exceeded. Wait `Retry-After` seconds before retrying.

---

[API](https://skmtc.dev/hovercode/apis/hovercode-api.md) · [All operations](https://skmtc.dev/hovercode/apis/hovercode-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hovercode/apis/hovercode-api/revisions/4a9bc3cafe41?raw)
