---
title: "Update an existing review template"
method: PUT
path: "/review-template/{id}"
tags: ["Review Generation"]
---

# Update an existing review template

`PUT /review-template/{id}`

Updates a review template. When email is present the template type is EMAIL and the locations' businesses need the REVIEW_GENERATION_EMAIL product plan feature; when email is absent the template type is SMS (REVIEW_GENERATION_SMS). For EMAIL templates every review link must have a label.

## Path parameters

- `id` integer, required

## Request body

- object
  - `name` string, required — Display name of the review template
  - `locationIds` integer[], required — Ids of the locations this template applies to. The locations' businesses need the matching product plan feature (REVIEW_GENERATION_EMAIL or REVIEW_GENERATION_SMS).
  - `bodyText` string, required — Message body of the review request
  - `senderName` string, nullable — SMS sender name (3-11 characters), used for SMS templates
  - `email` object — Email settings. When present the template type is EMAIL and every review link needs a label; when absent the template type is SMS.
    - `senderEmailId` string, email, required — Sender email address. Must be a verified email identity (see the /identities endpoints).
    - `footerText` string, required — Footer text shown at the bottom of the review request email
    - `subject` string, required — Subject line of the review request email
    - `actionButtonColor` string, required — Hex color of the call-to-action button
    - `privacyLink` string, required — URL of the privacy policy linked from the email
    - `mediaIds` integer[], nullable — Ids of previously uploaded media (see the review-template media upload-url endpoint), e.g. the logo shown in the email
  - `reviewLinks` object[], required — Review platform links offered to the customer
    - `url` string, required — URL of the review platform, or the name of a location custom field that holds the URL per location. Yelp is not supported.
    - `label` string, nullable — Display label of the review link. Required for every review link when email is present on the template.

## Response `200`

OK response

- object
  - `id` integer, nullable
  - `type` string, nullable
  - `name` string, nullable
  - `locationIds` integer[], nullable
  - `bodyText` string, nullable
  - `senderName` string, nullable
  - `email` object
    - `senderEmailId` string, required
    - `footerText` string, required
    - `subject` string, required
    - `actionButtonColor` string, required
    - `privacyLink` string, nullable
    - `media` object[], nullable
      - `mediaId` integer, nullable
      - `message` string, nullable
      - `uploadUrl` string, nullable
  - `reviewLinks` object[], nullable
    - `url` string, required
    - `label` string, nullable
  - `createdAt` string, nullable
  - `updatedAt` string, nullable
  - `errors` string[], nullable
  - `message` string, nullable

## Other responses

- `400` — Invalid ReviewTemplateRequest
- `401` — User does not have right permission to perform this action or does not have access to specified locations
- `404` — Review template not found

---

[API](https://skmtc.net/uberall/apis/uberall-api.md) · [All operations](https://skmtc.net/uberall/apis/uberall-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uberall/uberall-api/revisions/3e6bbc61550f/schema)