Update the preferences of a user.

patch

https://api.skyswitch.com/users/{user_uuid}/preferences

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

user_uuid

string

required

Body Params

doNotDisturb

boolean

Enable/Disable do not disturb mode.

showRecordings

boolean

Show/Hide recordings in the call history list.

disableNotifications

boolean

Enable/Disable notifications.

disableCalls

boolean

Enable/Disable calls.

hourFormat

string

Hour format (12 or 24).

timezone

string

Timezone.

smsNotifications

array

SMS notifications.

smsNotifications

incomingSmsSounds

boolean

Enable/Disable incomig sms sounds.

incomingChatSounds

boolean

Enable/Disable incoming chat sounds.

messageNotifications

array

Message notifications.

messageNotifications

disableContactMatching

boolean

Enable/Disable contact matching for incoming calls.

callForwardAlways

boolean

Forward all incoming calls to a selected destination.

callForwardDestination

string

Destination to forward all incoming calls to.

tryFirst

string

Try first destination.

tryFirstExtension

string

Try first extension.

tryFirstRingTime

string

Ring time in seconds.

busyTry

string

If busy try this first.

busyTryDestination

string

If busy try this destination.

notAnsweredTry

string

If not answered try this first.

notAnsweredTryDestination

string

If not answered try this destination.

offlineTry

string

If offline try this first.

offlineTryDestination

string

If offline try this destination.

ringingSoundVolume

integer

Volume of the ringing sound.

speakerDevice

string

Speaker device.

microphoneDevice

string

Microphone device.

blockAnonymous

boolean

Block Anonymous or Unknown Numbers.

notificationSpeakerDevice

string

Notification speaker device.

mirrorLocalVideo

boolean

Mirror local video.

cameraOn

boolean

Camera on when entering meeting.

blurBackground

boolean

Blur video background.

cameraDevice

string

Camera device.

faxNotifications

array

Fax notifications.

faxNotifications

missedCallNotifications

array

Missed call notifications.

missedCallNotifications

callNotifications

array

Call notifications.

callNotifications

chatNotifications

array

Chat notifications.

chatNotifications

secondCallNotifications

array

Second call notifications.

secondCallNotifications

contactTypeFilter

string

Contact type filter. Allowed values are shared,personal,company.

screenPopUrl

string

Valid URL for the inbound screen pop when an agent answers a call.

enableAgentMessage

boolean

If enabled it will show the Message to Agent option.

showStats

boolean

Show/hide the my stats option for call center agents.

showGraphs

boolean

If enabled, my stats graph will be shown for a call center agent.

companionWeb

array

Companion mode settings for the web client.

companionWeb

companionLink

array

Companion mode settings for Link.

companionLink

contactSort

array

Contacts sort preferences.

contactSort

attendantConsole

array

Attendant console preferences.

attendantConsole

showCallsAnswElse

boolean

Show calls are answered elsewhere.

showMissedQueueCalls

boolean

Show missed queue calls.

loginMethod

string

answeringRules

array

Answering rule preferences.

answeringRules

distinctiveRing1

array

Distinctive ring 1 notification settings.

distinctiveRing1

distinctiveRing2

array

Distinctive ring 2 notification settings.

distinctiveRing2

distinctiveRing3

array

Distinctive ring 3 notification settings.

distinctiveRing3

Response

Language

Loading…

Response

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

application/json

200Success.