Update a user's notification settings.

patch https://api.visualvisitor.com/api/v1/users/{id}/notification

Minimal scope required: "users.update".

Path Params

string

required

The unique identifier of the user to update. This parameter is required and passed in the URL.

Query Params

customerId

string | null

Optional query parameter, allowing partners to perform this action on behalf of their customer.

api-version

string | null

Body Params

The JSON object containing the fields to update for the user.
Non-null or non-empty fields in this object will overwrite the corresponding fields in the existing user.

instantNoticationEnabled

boolean | null

Optional, enables sending notifications on website visits.

requiredPageVisits

int32 | null

Optional, the number of visits needed to trigger the instant notification (up to 50).

duplicateLeadNotificationDelayDays

int32 | null

Optional, the delay, in days, before sending a notification for a duplicate visitor lead (up to 30).

dailyReportingEnabled

boolean | null

Optional, enables sending daily reports.

topActiveLeadsInDailyReport

int32 | null

Optional, the number of top active leads to display in the daily report (up to 200).

weeklyReportingEnabled

boolean | null

Optional, enables sending weekly reports.

topActiveLeadsInWeeklyReport

int32 | null

Optional, the number of top active leads to display in the weekly report (up to 200).

urlWatchNotificationEnabled

boolean | null

Optional, enables instant alerts for visits to pages defined in the URL watch list.
Alerts will always be sent when a matching page is visited,
provided that instantNotificationEnabled is also turned on.

urlWatchNotificationList

array of strings | null

Optional, a list of URLs to be monitored for visits. Notifications will be sent if urlWatchAlertsEnabled is turned on.

urlWatchNotificationList

stateNotificationFilter

array of strings | null

Optional, a list of state keys used to filter notifications. Notifications will only be sent if the lead is located in one of the specified states.
The values should correspond to the keys from the reference/states resource.

stateNotificationFilter

webhookNotificationEnabled

boolean | null

Optional, enables the use of a webhook for instant and URL watch notification alerts instead of sending emails.

webhookNotificationUrl

string | null

Optional, the URL to which webhook notifications will be posted.

Headers

X-Version

string | null

Responses

500

Language

Credentials

Header


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api.visualvisitor.com/api/v1/users/id/notification \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Task completed returns the value "success".

400

401

403

404

429