A review invite.
| Attribute | Type | Description |
|---|---|---|
| location.uid | string | Podium unique identifier for location. |
| location.organizationUid | string | Podium unique identifier for organization. |
| test | boolean | Whether or not the review invite was a test. |
| url | string | Url to view the review invite in Podium. |
| uid | string | Podium unique identifier for review invite. |
| channel.type | string | Messenger channel for the conversation. Possible values: ["apple", "car_wars", "email", "facebook", "fallback_email", "google", "google_brand", "iframe", "instagram", "phone", "secure", "sms", "text", "whatsapp"] |
| channel.identifier | string | Identifies the Messenger channel. Must be a valid email address or a phone number. Non-US/Canada numbers must include the country code (e.g. +61 for AUS) |
| sender.name | string | Name of the employee that sent the review invite. If it was an automated invite the value will be external. |
| sender.type | string | Type of entity that sent the review invite. Possible values: ["user", "integration"] |
| sender.uid | string | Podium unique identifier for user or integration. |
| sender.sentThrough | string | Podium product that the review invite was sent through. Possible values: ["client_app", "feedback", "generated_link_only", "integrations", "payments", "email", "sms", "mms", "external"] |
| languages | array[string] | Language of the review invite message. |
| createdAt | string | When the review invite was created. |
| updatedAt | string | When the review invite was updated. |
| attributions | array | Review that was created from the invite. |
| attributions[].siteName | string | Name of the site that the review was published on. |
| attributions[].reviewAuthor | string | Name of person who created the review. |
| attributions[].reviewBody | string | Body of the review. |
| attributions[].reviewPublishedAt | string | When the review was published. |
| attributions[].reviewRating | number | Rating of the review. |
| attributions[].reviewUid | string | Podium unique identifier for review. |
| customerName | string | The name of the customer that the review invite was sent to. |
| deliveryStatus | string | Delivery status of the review invite. Possible values: ["failed", "pending", "sent", "delivered"] |
| conversationItemUid | string | Podium unique identifier for conversation item. |
| linkClicked | boolean | Whether or not the review invite link has been clicked. |
| linkClickedAt | string | When the review invite link was clicked. |
| shortUrl | string | Short form url to view the review invite in Podium. |
{
"location": {
"uid": "00000000-0000-0000-0000-000000000000",
"organizationUid": "00000000-0000-0000-0000-000000000000"
},
"test": false,
"url": "http://app.podium.com/#/91f85f79-185c-46cb-830d-79f259bb2822?v2=true",
"uid": "00000000-0000-0000-0000-000000000000",
"channel": {
"type": "email",
"identifier": "[email protected]"
},
"sender": {
"name": "Jack Grape",
"type": "user",
"uid": "00000000-0000-0000-0000-000000000000",
"sentThrough": "client_app"
},
"languages": [
"en"
],
"createdAt": "2015-01-23T23:50:07Z",
"updatedAt": "2015-01-23T23:50:07Z",
"attributions": [
{
"siteName": "google",
"reviewAuthor": "Joe Orange",
"reviewBody": "Great service!",
"reviewPublishedAt": "2015-01-23T23:50:07Z",
"reviewRating": 5,
"reviewUid": "00000000-0000-0000-0000-000000000000"
}
],
"customerName": "John Apple",
"deliveryStatus": "failed",
"conversationItemUid": "00000000-0000-0000-0000-000000000000",
"linkClicked": false,
"linkClickedAt": "2015-01-23T23:50:07Z",
"shortUrl": "https://podium.co/QDNrE1v"
}