User Endpoints: UPDATE A USER

UT /api/users/:id, parameters:

PARAMS KEY MANDATORY TYPE Description Example
ID (in URL) yes integer User uniq ID 8
first_name no string first_name John
last_name no string last_name Doe
subscriber no string User extension 1001
email no string email john@doe@email.ca
department_id no | can be default per install string Actually department name … finance
realm_id yes | can be default per install integer Uniq ID of client’s domain 4
realm yes | can be default per install string Client’s domain office.modulis.clusterpbx.ca
language yes | can be default per install string user language en / fr
profile_id yes | can be default per install integer User profile ID 1
mac no if ignore_phone_params is true string Phone Mac Address 0004f218343c
model no if ignore_phone_params is true integer Phone Model ID

(17=’softphone’)

 17
prov_tmpl no if ignore_phone_params is true integer Provisioning Template ID 33
clid_name_external no string External CallerID name John Doe
clid_num_external no string External CallerID Number 5142842020
clid_name_internal no string Internal CallerID name John Doe
clid_num_internal no string Internal CallerID Number 5142842020
exclude_from_directory no “yes” or “no” Exclude user from directory yes
ignore_phone_params no true or false Will ignore phone params:

  • mac
  • phone model
  • provisioning template
 true
vm_pin no integer voicemailbox pin 123456
attach no “yes” or “no” enable/disable vm to email yes
email_vm_to_email no string vm to email: email email@test.ca
custom_deletevoicemail no “yes” or “no” delete voicemail after vm to email notification no
pagerdest no string vm to email: email

for pager (use plain text)

 test@modulis.ca
dnd_status no boolean Do Not Disturb status 0
followme_status no string Follow Me Number 5142842020
callwaiting_status no boolean Call Waiting 1

Results example:

JSON – output

{
   "success": true,
   "message": "User John Doe successfully updated",
   "id": 12455
}

Example (assuming we made default-able variable default):