PriceRules

PUT /PriceRules/{id}

Changed on

Request

Path parameters

idstring required

Request body

namestring
descriptionstring nullable
isActiveboolean
ruleTypestring
scopestring
groupCodeIdstring nullable
validFromstring date-time nullable
validTostring date-time nullable
stackingOverridestring nullable
clientTagIdsstring[]

Customer-tag ids that gate this rule (empty = applies to any client).

Response

OK

idstring
namestring
descriptionstring nullable
isActiveboolean
ruleTypestring

One of: BuyXGetYFree, BuyXGetYPercentOff, SpendThreshold, QuantityTier.

scopestring

One of: GroupCode, Global.

groupCodeIdstring nullable
validFromstring date-time nullable
validTostring date-time nullable
stackingOverridestring nullable

One of: BestWins, Stack, or null to inherit the tenant setting.

managedByGroupCodeIdstring nullable

Set when a wellness plan's member discount owns this rule (ITE-660) — the rules API refuses edits/deletes; change the plan instead.

clientTagIdsstring[]

Customer-tag ids that gate this rule. Empty = applies to any client; when non-empty the rule fires only for clients carrying at least one of them.

createdAtstring date-time
updatedAtstring date-time

Changes

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)