These docs are for v2.11. Click to read the latest docs for v2.12.

Update User

Update a User.

Notes

dashboard_role

User role in the account. Value can be None, Location, Organization, Agent or Master.

dashboard_access

User access option. Value can be None, User, Manager, Administrator or Custom.

first_name

User's first name.

last_name

User's last name.

title

Title or label given to a user.

fractelfone

FracTELfone device assigned to a user. It accepts device id, "none" or "new" as the values. Use "none" to clear assigned fractelfone and use "new" to create a new FracTELfone.

account_id

Account code or Subaccount code a user belongs to.

custom_access

Custom access options, required if the parameter "dashboard_access" is set to "Custom". Options:

  • subaccounts: None, Read, Edit or Add.
  • users: None, Read, Edit, Add or Remove.
  • business_objects: None, Read, Edit, Add or Remove.
  • fonenumbers: None, Read, Edit, Add or Remove.
  • billing: None or Read.
  • call_records: None or Read.

Sample Response

{
  "user": {
    email: "[email protected]",
    dashboard_role: "Location",
    dashboard_access: "Custom",
    first_name: "John",
    last_name: "Doe",
    title: "CEO",
    fractelfone: "999999999999",
    account_id: "2005559999",
    custom_access: {
      subaccounts: "Add",
      users: "Remove",
      business_objects: "Remove",
      fonenumbers: "Remove",
      billing: "Read",
      call_records: "Read"
    }
  }
}

Response Properties

PropertyTypeDescription
userobjectUser
Language
Credentials
Header
Click Try It! to start a request and see the response here!