Rivier/ Reference/ contacts

Change a reward. Rewards already taken keep what they were

put/loyalty/rewards/{id}

Before you call

Credential
Authorization: Bearer $KEY
Scope
contacts:admin
Sdk
contacts.loyalty.updateReward
Cli
contacts loyalty update reward

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • namestringrequired
    At most 80 characters.
  • descriptionstring
    Default: . At most 400 characters.
  • costPointsintegerrequired
    At least 1. At most 10000000.
  • kindstringrequired
    One of: percent, fixed, free_shipping, gift.
  • percentBpinteger or null
  • amountMinorinteger or null
  • currencystring or null
  • minSubtotalMinorinteger
    Default: 0. At least 0. At most 100000000.
  • validDaysinteger
    Default: 60. At least 1. At most 365.
  • positioninteger
    Default: 0. At least 0. At most 1000.

Responses

  • 200application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown