Sign in
OpenAPI 3.0.1Licensed under Uberall2026-08-1330255314.1 MB

3e6bbc61550f

Review Generation

Start a review generation job for given customer location Ids and review template Id

Starts a review generation job that sends the review requests to the given customer locations using an existing review template. NOTE: delivery is immediate — the scheduledDateTimeUtc parameter is not supported, does not defer sending, and will be removed in a future version. When the user lacks the required feature or the review template id does not exist, the response is HTTP 200 with an empty jobs list and an explanatory message. If any review link cannot be resolved for any of the given locations, the entire request is rejected: no jobs are created and the failure reasons are reported in the errors field.

post/review-template/job

Request body

customerLocationIdsinteger[] required

Ids of the customer locations (created via the customer-management service) that should receive the review request

reviewTemplateIdinteger required

Id of an existing review template

scheduledDateTimeUtcstring

WARNING: this parameter is not supported — review requests are dispatched immediately upon job creation regardless of this value, and the parameter will be removed in a future version. If provided, it must be an ISO-8601 local date-time without timezone offset.

Example request

{
  "scheduledDateTimeUtc": "2026-08-04T12:34:56.789"
}

Response

OK. jobs is empty and message is set when the user lacks the required feature or the review template does not exist; jobs is empty and errors is populated when any review link cannot be resolved.

messagestring nullable

Explanation when nothing or only part of the request could be scheduled

errorsstring[] required

Validation problems that blocked scheduling, e.g. review links that cannot be resolved for a location

Example response

{
  "jobs": [
    {
      "reviewTemplate": {
        "createdAt": "2026-08-04T12:34:56.789",
        "updatedAt": "2026-08-04T12:34:56.789"
      },
      "createdAt": "2026-08-04T12:34:56.789",
      "scheduledDateTimeUtc": "2026-08-04T12:34:56.789"
    }
  ]
}