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

SendUser (Push Method)

    SendUser

    Creates a new user under the API‑requesting vendor’s company.
    Only Vendor Admins are allowed to create users.
    Vendor Users cannot create other users.

    Request
    Parameter Type Description
    Email String Required. User 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 either Vendor User or Vendor Admin.
    Status String Required. Must be Active or Inactive.
    PendingEmailNotification String Optional. Whether a pending notification should be sent.
    UserAccount String Optional. Associates internal user account ID (if applicable).
    Response
    Parameter Type Description
    Success Message String Returned when user is successfully created.
    Errors Array Contains error message(s) should an error occur.
    Example (C#)

     

    // setup request parameters
    ParametersForUserCreation objCreatUserParams = 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 SendUserResponse = apiClient.SendUser(objCreatUserParams);
    Console.WriteLine("SendUser: {0}", SendUserResponse);