Create or edit a review widget

Create a widget for a location, or change an existing one's title and settings. Without unique_id a new widget is created; with it, that widget's widget_title and widget_options are replaced (its style stays). Leaving either field out clears it. Returns the widget's unique_id, which goes in the embed code. Creating a widget counts toward your plan's widget limit (402 when reached); the location needs an active widget add-on (400 otherwise).

Prerequisites: a bearer token, the location's store_id, a style id (widget_type_id) from List widget styles, and to edit, the widget's unique_id.

Authentication: Partner or Account token. store_id must be inside your own account tree (a Partner token reaches any location under the partner, an Account token only its own); otherwise 422. To edit, unique_id must be one of your widgets.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
Defaults to 3007

The widget's location. Must exist and be inside your account tree, and have an active widget add-on.

integer
required
Defaults to 1

The style, from List widget styles. Must exist. Used when creating; an existing widget keeps its style.

string
Defaults to abc123

The widget to edit. Leave it out to create a new widget.

string
length ≤ 255
Defaults to My Feed Widget

The widget's title, up to 255 characters. Left out: cleared.

widget_options
object

The widget's display settings, saved as sent. Left out: cleared. The feed reads numberOfReviews (reviews per page) and reviewSiteValue.value (the review site to show).

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json