👩‍👩‍👧‍👧PUT - Users Bulk

api.put.users_bulk()

Updates specified list of User's options, such as extension, name and etc.

Note: Available options to change can be seen through: get.user_by_id()

Parameters

• users (list): List of specified User IDs to update

• updates (dict): The updates to be applied to the list of Users e.g {"extension":"9999"}

Returns

• Dict: Returns the changes made including the list of User IDs and updates.

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_users = [
  "[e-mail]",
  "[e-mail]"
]

my_user_payload = {
    "address": {
        "addressLine1": "Bldg 1",
        "addressLine2": "Suite 2",
        "city": "Cincinnat",
        "stateOrProvince": "Ohio",
        "zipOrPostalCode": "45204",
        "country": "US"
    }
}

my_api.put.users_bulk(
    my_users,
    my_user_payload
)

Example Data Returned (Formatted)

[
  {
  "users": [
    {"userId": "[e-mail]"}, 
    {"userId": "[e-mail]"}
    ], 
  "data": {
    "address": {
      "addressLine1": "Bldg 1", 
      "addressLine2": "Suite 2", 
      "city": "Cincinnat", 
      "stateOrProvince": "Ohio", 
      "zipOrPostalCode": "45204", 
      "country": "US"
      }
     }
  }
]