reviews_endpoints

Reply or schedule a reply to a review

post/v1/reviews/reply

Request

Base URL
https://partners.tryotter.com
Auth
OAuth 2
Authorization code/v1/auth/oauth2/authorize
Client credentials
Token URL/v1/auth/token
Scopesreviews.reply
TypeScript
https://skmtc.dev/cloudkitchens/apis/otter-api/docs/v1/reviews/reply/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

reviewIdstring

The review ID.

externalStoreIdstring

External store ID of the review you are responding to. Fails the requests if invalid external store ID is passed.

serviceSlugstring

The slug of the service for the review.

replyTextstring

The reply text. Limits vary by serviceSlug and are measured in UTF-8 bytes.

scheduledAtinteger nullable

Unix timestamp in seconds for requested scheduled execution. A successful response confirms scheduling only; execution may occur later.

Example request

{
  "reviewId": "review-56e9-46be",
  "externalStoreId": "order-1fa4-479c",
  "serviceSlug": "ubereats",
  "replyText": "Thank you very much.",
  "scheduledAt": 1697727006
}

Response

The immediate reply was posted, or the scheduled reply task was created. A scheduled response does not confirm later provider execution.

replyIdstring nullable

Opaque reply identifier returned by the target service for an immediate reply. Scheduled responses do not include an eventual reply ID.

Example response

{
  "replyId": "reply-f34f-4d35"
}

Changes

No recorded changes to this operation across all 1 revision of this API.