TagoIO SDK for JavaScript and TypeScript
    Preparing search index...

    Interface UserListScope

    User List scope to be used in your analysis example:

    • async function editUser({ scope }: RouterConstructor & { scope: UserListScope[] }) {}
    interface UserListScope {
        active?: boolean;
        company?: string;
        email?: string;
        generate_password?: boolean;
        language?: string;
        name?: string;
        old?: { [key: string]: string } & Partial<
            Omit<UserCreateInfo, "password" | "tags">,
        >;
        options?: UserOptions;
        phone?: string;
        send_email?: string | boolean;
        timezone?: string;
        user: string;
        [key: string]: any;
    }

    Hierarchy

    Indexable

    • [key: string]: any

      Tag keys are formated as tags.key and parameters as param.key

    Index

    Properties

    active? company? email? generate_password? language? name? old? options? phone? send_email? timezone? user

    Properties

    active?: boolean
    company?: string
    email?: string
    generate_password?: boolean

    The server generates the password and turns on force_password_change. Omit password when true; sending both is rejected.

    language?: string
    name?: string
    old?: { [key: string]: string } & Partial<
        Omit<UserCreateInfo, "password" | "tags">,
    >

    old parameter key will include a json with the old values of the parameters

    options?: UserOptions
    phone?: string
    send_email?: string | boolean

    Sends a welcome email. true uses the Run's welcome template; a string names an email_templates key. Unknown keys fall back to welcome, then to a built-in default.

    timezone?: string
    user: string

    Settings

    Member Visibility

    On This Page

    Properties