kustomer-client
    Preparing search index...

    Function createInviteNewUser

    • Create / Invite New User Creates an account for a new user and sends an email invitation to join the organization within Kustomer.

      Requires org.admin.user permissions. The permissions for the new user cannot exceed those of the user making the request and will be filtered automatically. The default roles for new users are org.admin and org.user.

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      avatarUrl: string;
                      createdAt: string;
                      displayName: null
                      | string;
                      email: string;
                      emailSignature: null | string;
                      mobile: null | string;
                      name: string;
                      password: { allowNew: boolean; forceNew: boolean; updatedAt: string };
                      roleGroups: string[];
                      roles: string[];
                      updatedAt: string;
                      userType: string;
                  };
                  id: string;
                  links: { self: string };
                  relationships: {
                      org: { data: { id: string; type: string }; links: { self: string } };
                  };
                  type: string;
              };
          },
          unknown,
          ThrowOnError,
      >

    Settings

    Member Visibility

    On This Page

    Note