loading

Review: Create

Create a new Review.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
required
object
authorName
required
string

The name of the person who wrote the review.

authorEmail
required
string

The email address of the person who wrote the review.

title
string

The title of the review.

rating
required
number <double>

Normalized rating out of 5.

content
required
string

The content of the review.

status
string
Enum: "LIVE" "QUARANTINED" "REMOVED"

The status of the review. Defaults to QUARANTINED when creating.

reviewLabelNames
Array of strings

The names of the Review Labels which will be attached to the resulting review.

This is an upsert operation, meaning the system will determine if a Review Label exists already in your account, and create and append a new label if not.

reviewDate
string <date>

If provided, the date you received the review from the customer. Defaults to the date the review was uploaded to Yext.

(YYYY-MM-DD format)

invitationUid
string

The ID of the invitation which should be associated with this review.

Responses

Request samples

Content type
application/json
{
  • "entity": {
    },
  • "authorName": "string",
  • "authorEmail": "string",
  • "title": "string",
  • "rating": 0,
  • "content": "string",
  • "status": "LIVE",
  • "reviewLabelNames": [
    ],
  • "reviewDate": "2019-08-24",
  • "invitationUid": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Review: Update

Update a Review.

path Parameters
accountId
required
string
apiIdentifier
required
string

The unique identifier of this review.

One of:

  • A UUID generated at the time the Review Creation request is accepted.
  • The invitationUid, if the review is associated with an invitation.

This ID will be returned in the response to any requests to the Review: Create Live API endpoint.

This ID will also be included in the Reviews Webhook, and the Review: Get/List Knowledge API endpoints.

query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
authorName
string

The name of the person who wrote the review.

authorEmail
string

The email address of the person who wrote the review.

title
string

The title of the review.

rating
number <double>

Normalized rating out of 5.

content
string

The content of the review.

status
string
Enum: "LIVE" "QUARANTINED" "REMOVED"

The status of the review. Defaults to QUARANTINED when creating.

reviewLabelNames
Array of strings

The names of the Review Labels which will be attached to the resulting review.

This is an upsert operation, meaning the system will determine if a Review Label exists already in your account, and create and append a new label if not.

reviewDate
string <date>

If provided, the date you received the review from the customer. Defaults to the date the review was uploaded to Yext.

(YYYY-MM-DD format)

Responses

Request samples

Content type
application/json
{
  • "authorName": "string",
  • "authorEmail": "string",
  • "title": "string",
  • "rating": 0,
  • "content": "string",
  • "status": "LIVE",
  • "reviewLabelNames": [
    ],
  • "reviewDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Review: Delete

Delete a Review.

path Parameters
accountId
required
string
apiIdentifier
required
string

The unique identifier of this review.

One of:

  • A UUID generated at the time the Review Creation request is accepted.
  • The invitationUid, if the review is associated with an invitation.

This ID will be returned in the response to any requests to the Review: Create Live API endpoint.

This ID will also be included in the Reviews Webhook, and the Review: Get/List Knowledge API endpoints.

query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
authorName
string

The name of the person who wrote the review.

authorEmail
string

The email address of the person who wrote the review.

title
string

The title of the review.

rating
number <double>

Normalized rating out of 5.

content
string

The content of the review.

status
string
Enum: "LIVE" "QUARANTINED" "REMOVED"

The status of the review. Defaults to QUARANTINED when creating.

reviewLabelNames
Array of strings

The names of the Review Labels which will be attached to the resulting review.

This is an upsert operation, meaning the system will determine if a Review Label exists already in your account, and create and append a new label if not.

reviewDate
string <date>

If provided, the date you received the review from the customer. Defaults to the date the review was uploaded to Yext.

(YYYY-MM-DD format)

Responses

Request samples

Content type
application/json
{
  • "authorName": "string",
  • "authorEmail": "string",
  • "title": "string",
  • "rating": 0,
  • "content": "string",
  • "status": "LIVE",
  • "reviewLabelNames": [
    ],
  • "reviewDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}