IPWorks Cloud 2020 JavaScript Edition

Questions / Feedback?

UpdateClient Method

Updates a client's information.

Syntax

async sharefile.updateClient(userId : string, firstName : string, lastName : string, email : string, company : string): Promise<void>

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");

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 JavaScript Edition - Version 20.0 [Build 8265]