API Reference

Create Business Reviews Settings

post
https://api.vcita.biz/v3/reviews/business_reviews_settings

Overview

Create new business reviews settings.

Authentication

Available for Staff Tokens.

Uniqueness Constraint

Each business can only have one Business Reviews Settings record. If settings already exist for the business, the API returns HTTP 409 Conflict. Use PUT /v3/reviews/business_reviews_settings/{business_uid} to update existing settings.

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

The unique identifier (UID) of the business. Required.

boolean

Whether to prompt clients to leave a public review on Google or Facebook after submitting a review.

boolean

Enables the client to decide whether their review is shared with that external review site.

integer

The ID of the external review platform (1=Google, 2=Facebook)

platform_params
object

Platform-specific parameters needed to properly route the review

Responses

Updated 2 months ago

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

Updated 2 months ago