API

Update a Custom Label

patch
https://core-api.ternary.app/api/custom-label-statements/

Update an existing Custom Label rule. All fields are optional — only the provided fields are updated. The rule can be transitioned between statuses (e.g. DRAFT to ACTIVE) by setting the status field.

Changing conditions or outputs on an active rule triggers reprocessing of the affected billing data.

See Custom Labels for more details.

Path Params
uuid
required

Unique custom label statement ID

Body Params

Request body for updating an existing Custom Label rule.

condition

Condition tree that determines which billing line items the rule applies to. A Condition is one of: a Filter (equals, like, set), a Level2Condition (and / or / not over filters), or a Level3 logical operator (and / or / not over filters and level-2 conditions). Nesting is bounded at three levels.

dependsOn
array of uuids | null
dependsOn
string | null
string
outputs
array of objects
length ≥ 1

When provided, every item must match the existing rule's outputType — TEMPLATE expects OutputTemplate items, MAPPING expects OutputMapping items, DATA_MAPPING expects OutputDataMapping items. outputType itself is immutable.

outputs
number
string | null
string
enum
Allowed:
string

Base64-encoded CSV carried inside the JSON body. When the rule's outputType is DATA_MAPPING, the server uses this file to populate mappingURI on updated outputs that don't supply one directly. Omit when every output already supplies its own mappingURI.

Responses

Updated 12 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 days ago