Skip to main content
PATCH
Update tag dimension by key

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.

dimensionKey
string
required

The key string 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.

display_name
string | null

Display name for the tag dimension. Layer shows this as the filter label and the column header when the dimension splits a report.

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
Example:

"NON_BALANCING"

user_visible
boolean
default:false

Whether Layer's embedded components show this dimension to end users. Set this to true for a dimension that users tag with and filter reports by. The default of false keeps the dimension available for tagging and API-level filtering, but hides it in the UI.

Response

Tag dimension updated successfully.

data
object
required