Sign in
Review Generation

Update an existing review template

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.

put/customer-engagement/review-template/{id}

Path parameters

idinteger required

Request body

namestring required

Display name of the review template

locationIdsinteger[] 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).

bodyTextstring required

Message body of the review request

senderNamestring nullable

SMS sender name (3-11 characters), used for SMS templates

Example request

{
  "email": {
    "actionButtonColor": "#3C8ECB"
  }
}

Response

OK response

idinteger nullable
typestring nullable
namestring nullable
locationIdsinteger[] nullable
bodyTextstring nullable
senderNamestring nullable
createdAtstring nullable
updatedAtstring nullable
errorsstring[] nullable
messagestring nullable

Changes

Changed in 1 of the 14 revisions of this API.1

Of the 14 revisions, 2 have no diff computed.