loading

Review Generation Settings: Get

Returns all current generation settings for a specified account.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Review Generation Settings: Update

Updates any generation settings specified in a specified account. Call may include any/all settings available to the account. Settings not included will remain unchanged.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
maxEmailsPerDay
integer [ 0 .. 200 ]

Enables review invitations by email and indicates the maximum number of email invites our system will send on a per-location, per-day basis.

Must contain an integer value between 0 and 200. If 0 or null, review invitations by email will be disabled.

maxTextsPerMonth
integer >= 1

Indicates the maximum number of text invites our system will send on a per-location, per-month basis.

maxTextsPerDay
integer [ 1 .. 20 ]

Enables review invitations by text and indicates the maximum number of text invites our system will send on a per-location, per-day basis. We will send a maximum of 20 text invites per location per day.

If null, review invitations by text will be disabled.

maxContactFrequency
integer
Enum: 7 30 60 90

Indicates the minimum number of days that must pass before a given contact can be sent another review invitation. This setting will prevent you from contacting the same person repeatedly in a short time period.

If null, no maximum contact frequency will be enforced.

reviewQuarantineDays
integer [ 0 .. 7 ]

Prevents first-party reviews from immediately showing up on your website or wherever else you show your reviews. During this quarantine period, you may respond to reviews, increasing the likelihood that your customers will revise or remove their negative reviews.

privacyPolicy
string

Review-collection pages contain a link to the Yext privacy policy by default. This field lets you replace that link with a link to your own privacy policy.

Update request must contain a URL or null. If null, the Yext privacy policy link will be used.

If the v parameter is before 20200910, please refer to privacyPolicyOverride as the parameter name instead of privacyPolicy.

Responses

Request samples

Content type
application/json
{
  • "maxEmailsPerDay": 200,
  • "maxTextsPerMonth": 1,
  • "maxTextsPerDay": 1,
  • "maxContactFrequency": 7,
  • "reviewQuarantineDays": 7,
  • "privacyPolicy": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}