Entity description
A BusinessReviewSharing entity defines how a business shares client reviews with external platforms. It includes details about the external site, sharing consent, and platform-specific parameters for routing the review correctly.
Properties
| Name | Description | Type | Example |
|---|---|---|---|
| business_uid | The unique identifier (UID) of the business | string | d290f1ee26c54 |
| external_review_site_url | Specifies the external review site URL where the review will be shared | string | https://external_review_site_url.com |
| external_review_site_display_name | Specifies the display name of the external review site receiving the review | string | Some Name |
| display_review_sharing_consent | Enables the client to decide whether their review is shared with that external review site | boolean | true |
| platform_url_business_params | Defines the selected platform and its required routing parameters (e.g., Google place_id, Facebook yourbusiness) | object | See Platform Parameters Example below |
Platform Parameters
Google
{
"id": 1,
"name": "Google",
"params": {
"place_id": 173897183
}
}Facebook
{
"id": 1,
"name": "Facebook",
"params": {
"yourbusiness": 173897183
}
}Example
{
"business_uid": "d290f1ee26c54",
"display_review_sharing_consent": true,
"platform_url_business_params": {
"id": 1,
"name": "Google",
"params": {
"place_id": 173897183
}
},
"external_review_site_url": "https://external_review_site_url.com",
"external_review_site_display_name": "local.ch",
"created_at": "2021-07-20T14:00:00.000Z",
"updated_at": "2021-07-20T14:00:00.000Z"
}