Skip to content
API Reference/
/
Update an existing review...

Update an existing review template

Request

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
idinteger, (int64)required
Bodyapplication/jsonrequired
namestring, non-emptyrequired

Display name of the review template

locationIdsArray of integers, (int64), non-emptyrequired

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, non-emptyrequired

Message body of the review request

senderNamestring or null, [ 3 .. 11 ] characters

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

emailobject

Email settings. When present the template type is EMAIL and every review link needs a label; when absent the template type is SMS.

curl -i -X PUT \
  'https://uberall.com/api/customer-engagement/review-template/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "locationIds": [
      0
    ],
    "bodyText": "string",
    "senderName": "string",
    "email": {
      "senderEmailId": "user@example.com",
      "footerText": "string",
      "subject": "string",
      "actionButtonColor": "#3C8ECB",
      "privacyLink": "string",
      "mediaIds": [
        0
      ]
    },
    "reviewLinks": [
      {
        "url": "string",
        "label": "string"
      }
    ]
  }'

Responses

OK response

Bodyapplication/json
idinteger or null, (int64)
typestring or null
namestring or null
locationIdsArray of integers or null, (int64)
bodyTextstring or null
senderNamestring or null
emailobject
createdAtstring or null
updatedAtstring or null
errorsArray of strings or null
messagestring or null
Response
{
  "id": 0,
  "type": "string",
  "name": "string",
  "locationIds": [
    0
  ],
  "bodyText": "string",
  "senderName": "string",
  "email": {
    "senderEmailId": "string",
    "footerText": "string",
    "subject": "string",
    "actionButtonColor": "string",
    "privacyLink": "string",
    "media": [ … ]
  },
  "reviewLinks": [
    { … }
  ],
  "createdAt": "string",
  "updatedAt": "string",
  "errors": [
    "string"
  ],
  "message": "string"
}