---
title: "Create a new link type"
method: POST
path: "/v1/link-types"
tags: ["links"]
---

# Create a new link type

`POST /v1/link-types`

## Request

- Base URL: `https://demo.firefly-iii.org/api`
- URL: `https://demo.firefly-iii.org/api/v1/link-types`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://demo.firefly-iii.org/oauth/authorize`
    - Token URL: `https://demo.firefly-iii.org/oauth/token`
  - HTTP bearer

Creates a new link type. The data required can be submitted as a JSON body or as a list of parameters (in key=value pairs, like a webform).

## Headers

- `X-Trace-Id` string, uuid

## Request body

- LinkType
  - `name` string, string, required
  - `inward` string, string, required
  - `outward` string, string, required
  - `editable` boolean

## Response `200`

New link type stored, result in response.

- LinkTypeSingle
  - `data` LinkTypeRead, required
    - `type` string, string, required: Immutable value
    - `id` string, string, required
    - `attributes` LinkType, required
      - `name` string, string, required
      - `inward` string, string, required
      - `outward` string, string, required
      - `editable` boolean
    - `links` ObjectLink, required
      - `0` object
        - `rel` string, string
        - `uri` string, string
      - `self` string, uri

## Other responses

- `400`: Bad request
- `401`: Unauthenticated
- `404`: Page not found
- `422`: Validation error. The body will have the exact details.
- `500`: Internal exception

---

[API](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-14.md) - [All operations](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-14/llms.txt) - [OpenAPI document](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-14/revisions/73f0baf3c408?raw)