Update tag group

put

https://{tenant}.onechurchsoftware.com/api/accounting/tag-groups/{id}

Update an existing tag group. This is a full update: send the complete list of values. Values without an id are created, and existing values omitted from the list are deleted unless they are referenced by a journal entry. First retrieve the current tag group from /api/accounting/tag-groups/{id}, apply your changes, then send back the full object.

Required permission: Accounting Settings

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the tag group

Body Params

The current version of the tag group

name

string | null

required

The tag group's name.

values

array of objects | null

required

The tags in the group, in display order. At least one active value is required and names must be unique within the group. On writes, the list replaces the group's values: values sent without an id are created, and existing values omitted from the list are deleted unless they are referenced by a journal entry.

values*

description

string | null

The tag group's description.

color

string | null

The tag group's display color, as a hex value.

required

boolean

Whether a tag from the group is required on journal entry line items.

active

boolean

Whether the tag group is active.

order

int32

The tag group's display order.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

200OK

404Not Found