Skip to main content
PATCH
/
v1
/
businesses
/
{businessId}
/
tags
/
dimensions
/
{dimensionId}
Update tag dimension
curl --request PATCH \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/tags/dimensions/{dimensionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "<string>"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "key": "<string>",
    "defined_values": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "<string>",
        "value": "<string>",
        "type": "TagValue",
        "display_name": "<string>",
        "archived_at": "2023-11-07T05:31:56Z"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "type": "com.layerfi.routers.ApiTagDimension",
    "display_name": "<string>",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Content-Type
string

Content-Type must be set to application/json.

Path Parameters

​
businessId
string<uuid>
required

The UUID of the business.

​
dimensionId
string<uuid>
required

The UUID of the tag dimension to update.

Body

application/json

Parameters for updating a tag dimension. All fields are optional.

​
key
string

The tag dimension key.

​
strictness
enum<string>

Tag strictness level - BALANCING requires tags to be applied to whole journal entries that balance, NON_BALANCING has no such restriction and can therefore be applied to individual line items of entries, invoices, etc.

Available options:
BALANCING,
NON_BALANCING

Response

Tag dimension updated successfully.

​
data
object
required