Purpose: Edit Web-Users

URL: https://www.commcarehq.org/a/[domain]/api/[version]/web-user/[id] 

Method: PUT 

Input Parameters:

Name 

Description 

Example 

username*

User name of user, including domain

jdoe@example.com

first_name

First name of user

John

last_name

Last name of user

Doe

email

Email address of user

john.doe@example.org

phone_numbers

List of all phone numbers of the user

(see examples)

This will replace existing phone numbers for the user.

role

Name of user role

(see examples)

permissions

Object representing user's permissions

(see examples)

is_admin

Whether the user is a project admin

true/false

 

Sample Input:

JSON Input
{
        "email":"admin@example.com",
        "first_name":"Joe",
        "is_admin": true,
        "last_name":"Admin",
        "permissions":{
           "edit_apps":true,
           "edit_commcare_users":true,
           "edit_data":true,
           "edit_web_users":true,
           "view_report_list":[
           ],
           "view_reports":true
        },
        "phone_numbers":[
        ],
        "role":"Admin",
        "username":"admin@example.com"
} 

  • No labels