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

Request

Starts a review generation job that sends the review requests to the given customer locations using an existing review template. NOTE: delivery is immediate; scheduling for a future time is not supported. The formerly documented scheduledDateTimeUtc parameter has been removed and is ignored when sent. 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.

Bodyapplication/jsonrequired

customerLocationIdsArray of integers, (int64), non-emptyrequired

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

reviewTemplateIdinteger, (int64)required

Id of an existing review template

curl -i -X POST \
  https://uberall.com/api/customer-engagement/review-template/job \
  -H 'Content-Type: application/json' \
  -d '{
    "customerLocationIds": [
      0
    ],
    "reviewTemplateId": 0
  }'

Responses

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.

Bodyapplication/json

jobsArray of objects or null

Scheduled jobs, one per customer location. Empty when nothing was scheduled.

messagestring or null

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

errorsArray of stringsrequired

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

Response

{
  "jobs": [
    { … }
  ],
  "message": "string",
  "errors": [
    "string"
  ]
}