UpdateClient Method

Updates a client's information.

Syntax

sharefile.updateClient(userId, firstName, lastName, email, company, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Updates a clients first name, last name, email, and/or company. UserId represents the string Id for the client that will be updated. FirstName, LastName, Email, and Company each represents the update value for their corresponding ShareFileUser* properties.

Passing an empty string for FirstName, LastName, Email, or Company will mean that the field will not be updated.

// Creates a client named FirstName Brown, with the email example@example.com with no company.
string userId = shareFile.CreateClient("FirstName", "Brown", "example@example.com", "");

// Updates the First name of the client to John and sets a company, leave everything else the same.
shareFile.UpdateClient(userId, "John", "", "", "nsoftware");