Skip to main content

Update the user​

Update the user

Path Parameters
    id string required

    The ID of the user to update

Request Body required
    availability string

    Possible values: [available, unavailable]

    The availability of the user

    firstName string

    The first name of the user

    lastName string

    The last name of the user

    email email

    The email address of the user

    phoneNumber object
    countryIsoCode string

    The country code of the user phone number in ISO 3166-1 alpha-2 format

    number string

    The phone number of the user, will be converted to E.164 format

    preferences object
    language string

    Possible values: [en, nl, es, sv]

    The language of the user in ISO 639-1 format

    defaultCountryCode string

    Possible values: [NL, BE, ES, SE]

    The default country code of the user in ISO 3166-1 alpha-2 format

    defaultOutboundNumber string

    The ID of the number that is preselected when making outbound calls

    colorMode string

    Possible values: [light, dark, system]

    The color mode of the user interface

    webphone object
    ringTone string

    Possible values: [ringtone1, ringtone2, ringtone3, ringtone4, ringtone5, ringtone6]

    The ringtone of the webphone

    ringDevice boolean

    Whether or not the Users device should also ring on incoming Webphone calls

    callWaiting object
    enabled boolean

    Whether or not call waiting is enabled for the Webphone

    playWaitingTone boolean

    Whether or not the waiting tone is played on a new incoming call

    notifications object
    missedCalls object
    enabled boolean

    Whether or not missed call notifications are enabled for the user

    channels array

    Possible values: [email, app]

    The channels on which missed call notifications are sent

    callOutsideBusinessHours object
    enabled boolean

    Whether or not call outside business hours notifications are enabled for the user

    channels array

    Possible values: [email, app]

    The channels on which call outside business hours notifications are sent

    voicemail object
    enabled boolean

    Whether or not voicemail notifications are enabled for the user

    channels array

    Possible values: [email, app]

    The channels on which voicemail notifications are sent

Responses

Successfully updated the user

Loading...