Rivier/ Reference/ hosting

Hosting site page widget

post/hosting/sites/{id}/pages/{page}/widgets

Place a widget block (form, newsletter, reviews, ratings, booking, buy button, cookie consent, language switcher, chat) on a page. The answer says whether the widget is live yet.

Before you call

Credential
Authorization: Bearer $KEY
Scope
hosting:write
Mcp
rivier_site_widget_place
Graphql
Mutation.hostingSitePageWidget
Sdk
hosting.sitePage.widget
Cli
hosting site page widget

Parameters

  • idstring (uuid)required
    In the path
  • pagestring (uuid)required
    In the path

Request bodyapplication/json, required

  • baseintegerrequired
    At least 0.
  • widgetstringrequired
    At most 40 characters.
  • parentstring or null
  • slotstring
    At most 24 characters.
  • indexinteger
    At least 0.
  • idstring
    At most 40 characters.
  • propsobject
  • bindingsobject
  • notestring
    At most 300 characters.

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