Rivier/ Reference/ contacts

Set up or change reviews and ratings. A person's setting

put/crm/reviews/settings

Before you call

Credential
Authorization: Bearer $KEY
Scope
contacts:admin
Sdk
contacts.reviews.settingsSave
Cli
contacts reviews settings save

Request bodyapplication/json, required

  • moderationstring
    One of: auto_verified, hold_all, hold_flagged. Default: hold_flagged.
  • requestsobject
    Default: {}.
    • enabledboolean
      Default: false.
    • onlyConsentedboolean
      Default: true.
  • incentiveobject
    Default: {}.
    • offeredboolean
      Default: false.
    • textstring
      At most 200 characters.
  • destinationobject
    • inboxIdstring (uuid)
  • allowedOriginslist of string
  • publishNoticestring
    Default: Your review will be shown with your first name and the first letter of your last name.. At most 300 characters.
  • defaultLanguagestring
    Default: en. Pattern: ^[a-z]{2}(-[A-Za-z]{2})?$.

Responses

  • 200application/json
    Success

    object

  • 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