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.

Completeness requirements (non-empty keys, values, patterns and outputs, a start date before the end date) apply to the rule as it will be stored after the update, using the stored status when status is omitted. A DRAFT may be incomplete, and DRAFT to ACTIVE fails if the stored rule is not yet complete.

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
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Unique custom label statement ID

Body Params

Request body for updating an existing Custom Label rule.

EqualsFilter | LikeFilter | SetFilter | Level2AndCondition | Level2OrCondition | Level2NotCondition | Level3AndCondition | Level3OrCondition | Level3NotCondition

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 | null

Day the rule stops applying, as an ISO 8601 date or datetime. Charges on this day are not labeled, so a rule for one day ends on the next day. Only the day is stored: any time of day or offset is ignored, and responses return midnight UTC. Must be a later day than startTime. Null means no end constraint.

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

First day the rule applies, as an ISO 8601 date or datetime. Only the day is stored: any time of day or offset is ignored, and responses return midnight UTC. Null means no start constraint.

string
enum

Optional. DRAFT, INACTIVE and PROCESSING are applied as sent; send PROCESSING to reprocess an ACTIVE or FAILED_PROCESSING rule without changing it. Changing a published rule's definition, or sending ACTIVE for a DRAFT or INACTIVE rule, sets the status to PROCESSING until the change is applied; the rule then reads ACTIVE, or FAILED_PROCESSING if the change could not be applied. Sending ACTIVE with no other change leaves a PROCESSING or FAILED_PROCESSING rule as it is. Changing only name or description leaves the status unchanged.

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 6 months ago

Did this page help you?
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 6 months ago

Did this page help you?