Skip to content
digizeDocs

Change Reviews settings

PATCH
/api/v1/reviews/settings
curl --request PATCH \
  --url https://digize.com/api/v1/reviews/settings \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "requests": { "afterOrders": true, "orderDelayDays": 1, "afterClasses": true, "classDelayDays": 1, "channel": "email", "emailTemplateId": "example", "smsTemplateId": "example", "destination": "google", "siteIfReviewed": true, "frequencyDays": 1 }, "widget": { "minStars": 1, "layout": "carousel", "includeExternal": true }, "notifications": { "lowRatings": true, "threshold": 1, "emails": [ "example" ], "weeklyDigest": true } }'

Changes some sections of Reviews settings: requests, the site widget or alerts. Sections left out stay as they are.

Needs the reviews:write permission.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
string
>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example 

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
requests
object
afterOrders
required
boolean
orderDelayDays
required
integer
<= 60
afterClasses
required
boolean
classDelayDays
required
integer
<= 60
channel
required
string
Allowed values: email sms auto
emailTemplateId
required
Any of:
string
<= 64 characters
smsTemplateId
required
Any of:
string
<= 64 characters
destination
required
string
Allowed values: google site
siteIfReviewed
required
boolean
frequencyDays
required
integer
>= 7 <= 365
widget
object
minStars
required
integer
>= 1 <= 5
layout
required
string
Allowed values: carousel grid list
includeExternal
required
boolean
notifications
object
lowRatings
required
boolean
threshold
required
integer
>= 1 <= 4
emails
required
Array<string>
<= 20 items
weeklyDigest
required
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
requests
required
object
afterOrders
required
boolean
orderDelayDays
required
integer
<= 60
afterClasses
required
boolean
classDelayDays
required
integer
<= 60
channel
required
string
Allowed values: email sms auto
emailTemplateId
required
Any of:
string
<= 64 characters
smsTemplateId
required
Any of:
string
<= 64 characters
destination
required
string
Allowed values: google site
siteIfReviewed
required
boolean
frequencyDays
required
integer
>= 7 <= 365
widget
required
object
minStars
required
integer
>= 1 <= 5
layout
required
string
Allowed values: carousel grid list
includeExternal
required
boolean
notifications
required
object
lowRatings
required
boolean
threshold
required
integer
>= 1 <= 4
emails
required
Array<string>
<= 20 items
weeklyDigest
required
boolean
sources
required
object
google
required
Any of:
object
account
required

The business’s name on Google.

string
location
required
string
connectedAt
required
string format: date-time
connectedBy
required
string
lastSyncedAt
required
Any of:
string format: date-time
syncing
required
boolean
error
required
string | null
facebook
required
Any of:
object
page
required

The Facebook Page’s name.

string
pageId
required
string
connectedAt
required
string format: date-time
connectedBy
required
string
lastSyncedAt
required
Any of:
string format: date-time
syncing
required
boolean
error
required
string | null
rating
required

Facebook’s own rating of the Page, out of 5.

number | null
ratingCount
required
number | null

Example 

{
  "requests": {
    "channel": "email",
    "destination": "google"
  },
  "widget": {
    "layout": "carousel"
  }
}

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

409

Section titled “409”

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

422

Section titled “422”

The Idempotency-Key was used with a different request.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}