Review Submission | Hitchhikers

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	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 the v parameter is before 20240515: (YYYY-MM-DD format) If provided, the date you received the review from the customer. Defaults to the date the review was uploaded to Yext. Time defaults to midnight ET. If the v parameter is 20240515 or later: ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD) if provided, the date you received the review from the customer. Date defaults to the date the review was uploaded to Yext. Time defaults to midnight and timezone defaults to UTC. Examples: 2024-05-15, 2024-05-15T04:44:50, 2024-05-15T04:44:50-05:00
invitationUid	string The ID of the invitation which should be associated with this review.
url	string The URL of the review, or the URL of the listing where the review can be found if there is no specific URL for the review.
publisherId	string The ID of the publisher associated with the review. Defaults to `FIRSTPARTY`.
externalId	string The External ID of the review, typically assigned by the Publisher. Created External IDs must be unique per account and publisher pair.

Responses

Request samples

Payload

Content type

application/json

{"entity": {"id": "string"
},
"authorName": "string",
"authorEmail": "string",
"title": "string",
"rating": 0,
"content": "string",
"status": "LIVE",
"reviewLabelNames": ["string"
],
"reviewDate": "2019-08-24",
"invitationUid": "string",
"url": "string",
"publisherId": "string",
"externalId": "string"
}

Response samples

202
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"apiIdentifier": "string"
}
}

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

	object
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)
url	string The URL of the review, or the URL of the listing where the review can be found if there is no specific URL for the review.
externalId	string The External ID of the review, typically assigned by the Publisher. Created External IDs must be unique per account and publisher pair.

Responses

Request samples

Payload

Content type

application/json

{"entity": {"id": "string"
},
"authorName": "string",
"authorEmail": "string",
"title": "string",
"rating": 0,
"content": "string",
"status": "LIVE",
"reviewLabelNames": ["string"
],
"reviewDate": "2019-08-24",
"url": "string",
"externalId": "string"
}

Response samples

202
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"apiIdentifier": "string"
}
}

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.

Responses

Response samples

202
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"apiIdentifier": "string"
}
}