Update tag value

Updates an existing tag value definition, including archiving/unarchiving functionality.

PATCH /v1/businesses/{businessId}/tags/dimensions/{dimensionId}/values/{valueId}

Update tag value

cURL

curl --request PATCH \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/tags/dimensions/{dimensionId}/values/{valueId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "display_name": "<string>",
  "is_archived": true
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "key": "<string>",
  "value": "<string>",
  "display_name": "<string>",
  "archived_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.

valueId · string<uuid> · required

The UUID of the tag value definition to update.

Body

application/json

Parameters for updating a tag value definition. All fields are optional.

label · string

Updated label for the tag value definition.

display_name · string | null

Updated display name for the tag value definition.

is_archived · boolean

Whether the tag value definition should be archived.

Response

200

application/json

Tag value definition updated successfully.

id · string<uuid> · required

Unique identifier for the tag value definition.

key · string · required

The tag dimension key.

value · string · required

The tag value.

display_name · string | null

Optional display name for the tag value definition.

archived_at · string<date-time> | null

Timestamp when the tag value definition was archived.