Praecise Platform
Menu

Rivier/ Reference/ contacts

Set the programme up or change it

put/loyalty

Set the programme up or change it: its name, what a point is called, how points are earned, levels, when points lapse, the terms, on or off.

Before you call

Credential
Authorization: Bearer $KEY
Scope
contacts:admin
Sdk
contacts.loyalty.set
Cli
contacts loyalty set

Request bodyapplication/json, required

  • statusstring
    One of: off, on.
  • namestring
    At most 80 characters.
  • pointNamestring
    At most 24 characters.
  • rulesobject
    • spendobject or null
      Default: null.
    • perOrderinteger
      Default: 0. At least 0. At most 1000.
    • perVisitinteger
      Default: 0. At least 0. At most 1000.
    • onJoininteger
      Default: 0. At least 0. At most 100000.
    • referralobject
      Default: {"referrer":0,"friend":0}.
      • referrerintegerrequired
        At least 0. At most 100000.
      • friendintegerrequired
        At least 0. At most 100000.
    • expiryMonthsinteger or null
      Default: null.
    • tierslist of object
      Default: [].
      • namestringrequired
        At most 40 characters.
      • fromPointsintegerrequired
        At least 1. At most 10000000.
      • multiplierBpinteger
        Default: 10000. At least 10000. At most 50000.
    • staffLimitinteger
      Default: 500. At least 0. At most 100000.
  • termsstring
    At most 4000 characters.

Responses

  • 200application/json
    Success
    • programobjectrequired
    • 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