Skip to main content

reviewRequests

Status: Trusted Tester

A Review Request is an instance of a business location attempting to send an email or SMS review request to a customer.

idstring
Example: RQT-00003fa2-bd72-40c2-9101-xxxxxxxxxxxx
typestring
Default value: reviewRequests
attributes object
requestTypestring

Possible values: [email, sms]

statusstring

sending- the initial status of a successfully created ReviewRequest.

sent- set when review request delivery is confirmed.

opened- set when an email review request has been opened.

clicked- set when the review site link has been clicked in a review request.

dropped- set when a review request delivery has failed ex. sending an SMS review request to a landline phone number.

unsubscribed- set when attempting to send a request to a customer that has previously unsubscribed from review requests from this business location.

Possible values: [sending, sent, opened, clicked, dropped, unsubscribed]

createdAtdate-time
updatedAtdate-time
relationships object
customer object
data object
idstringrequired

Should be in the format {{business location id}}:{{Vendasta customer id}}. Vendasta customer ids may be in the form of CUSTOMER-003c26eb-f940-48c6-a5dc-xxxxxxxxxxxx or CONTACT-003c26eb-f940-48c6-a5dc-xxxxxxxxxxxx.

Possible values: <= 256 characters

Example: AG-abc123:CUSTOMER-003c26eb-f940-48c6-a5dc-xxxxxxxxxxxx
typestring
Default value: customer
primaryTemplate object
data object
idstringrequired

Should be in the format {{business location id}}:{{template type}}:{{template id}}

Possible values: <= 256 characters

Example: AG-abc123:sms:TEM-d2f4cf1aa7ae480bbf0a2da67dxxxxxx
typestring
Default value: template
fallbackTemplate object
data object
idstring

Should be in the format {{business location id}}:{{template type}}:{{template id}}

Possible values: <= 256 characters

Example: AG-abc123:email:TEM-d2f4cf1aa7ae480bbf0a2da67dxxxxxx
typestring
Default value: template
reviewRequests
{
  "id": "RQT-00003fa2-bd72-40c2-9101-xxxxxxxxxxxx",
  "type": "reviewRequests",
  "attributes": {
    "requestType": "email",
    "status": "sending",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
  },
  "relationships": {
    "customer": {
      "data": {
        "id": "AG-abc123:CUSTOMER-003c26eb-f940-48c6-a5dc-xxxxxxxxxxxx",
        "type": "customer"
      }
    },
    "primaryTemplate": {
      "data": {
        "id": "AG-abc123:sms:TEM-d2f4cf1aa7ae480bbf0a2da67dxxxxxx",
        "type": "template"
      }
    },
    "fallbackTemplate": {
      "data": {
        "id": "AG-abc123:email:TEM-d2f4cf1aa7ae480bbf0a2da67dxxxxxx",
        "type": "template"
      }
    }
  }
}