FIfirefly-iii
links

Create a new link type

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).

post/v1/link-types

Request

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

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Request body

namestring string required
inwardstring string required
outwardstring string required
editableboolean

Example request

{
  "name": "Paid",
  "inward": "is (partially) paid for by",
  "outward": "(partially) pays for"
}

Response

New link type stored, result in response.

Example response

{
  "data": {
    "type": "link_types",
    "id": "2",
    "attributes": {
      "name": "Paid",
      "inward": "is (partially) paid for by",
      "outward": "(partially) pays for"
    },
    "links": {
      "0": {
        "rel": "self",
        "uri": "/OBJECTS/1"
      },
      "self": "https://demo.firefly-iii.org/api/v1/OBJECTS/1"
    }
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.