Skip to content
  • There are no suggestions because the search field is empty.

EditUser (Push Method)

EditUser

Updates an existing user record for the API‑requesting vendor's company.
Only Vendor Admins are allowed to edit users.
Vendor Users cannot edit user accounts.

Request
Parameter Type Description
Email String Required. User’s email address.
FirstName String Required. User’s first name.
LastName String Required. User’s last name.
MobileNumber String Optional.
TelePhone String Optional.
Role String Required. Must be Vendor User or Vendor Admin.
Status String Required. Must be Active or Inactive.
PendingEmailNotification String Optional.
UserAccount String Optional. Associates an internal account ID (if applicable).
Response
Parameter Type Description
Success Message String Returned when the user record is successfully edited.
Errors Array Contains error message(s) if an error occurs.
Example (C#)

 

// setup request parameters
ParametersForUserCreation objEditUserParams = new ParametersForUserCreation
{
    Email = "testuser@emailadress.com",
    FirstName = "Test",
    LastName = "user",
    MobileNumber = "",
    TelePhone = "",
    Role = "Vendor User",         // Vendor User or Vendor Admin
    Status = "Active",            // Active or Inactive
    PendigEmailNotification = true // True or False
};

dynamic EditUserResponse = apiClient.EditUser(objEditUserParams);
Console.WriteLine("Edit User Response: {0}", EditUserResponse);