🛑PUT - User Do Not Disturb

my_api.put.user_do_not_disturb()

This method updates the Do Not Disturb (DND) and Ring Splash (RS) status of a single. It takes a single User ID of the target user you would like to retrieve the status of.

Parameters

• user_id (str): Target user id of user you would like to update the state of.

• dnd_active (bool): True to enable DND and False to disable DND. Defaults to False.

• ring_splash_active (bool): True to enable Ring Splash and False to disable Ring Splash. Defaults to False

Returns

• Dict: Target users DND/ RS status. True is enabled and False disabled.

How To Use:

from odins_spear import api

my_api= api.Api(base_url="https://base_url/api/vx", username="john.smith", password="ODIN_INSTANCE_1")
my_api.authenticate()

my_api.put.user_do_not_disturb(
        user_id='UserID',
        dnd_active= True
        ring_splash_active= True     
)

Examples Data (Formatted)

{
  "isActive": true,
  "ringSplash": true,
  "userId": "[e-mail]"
}