HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Tariff group / set custom fields

⚠️ Experimental endpoint — not yet a stable contract. This action ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.

Set the applicable custom field values of a tariff group without changing its tariffs or other properties. This action requires permission to view the tariff group and the TariffGroups.update-custom-fields permission.

Send a JSON object containing the required customFields object. Omitted identifiers remain unchanged, while null clears the corresponding value. When custom fields are enabled for tariff groups, an empty object succeeds as a no-op. Invalid or unavailable identifiers and invalid values return 422 validation errors. If custom fields are disabled for the tenant or tariff groups, the action returns 412 Precondition Failed. Neither rejection changes submitted values. A 404 response means the tariff group was not found.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The tariff group ID to which the action will be applied

Body Params
customFields
object
required

Custom field values keyed by their administrator-defined identifiers. The accepted type for each identifier is defined by the tenant's custom field configuration. Boolean values are JSON booleans; text and long text values are strings; email values are email-formatted strings; URL values are HTTP or HTTPS URL strings; number values use canonical base-10 decimal strings from -99999999999999.999999 through 99999999999999.999999 with up to six fractional digits and no insignificant trailing fractional zeroes; date values are ISO 8601 YYYY-MM-DD strings; date-time values are ISO 8601 timestamps with a UTC offset; and JSON values may use any JSON-serializable value. Decimal strings are the precision-safe number request representation. JSON numeric inputs remain accepted for compatibility, but their precision may depend on the client's number handling.

Responses

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