inaturalistjs
    Preparing search index...

    Type Alias PostUser

    type PostUser = {
        iconDelete?: boolean;
        user?: {
            description?: string;
            email?: string;
            icon?: { [key: string]: unknown };
            locale?: string;
            login?: string;
            name?: string;
            placeId?: number;
            timeZone?: string;
        };
    }
    Index

    Properties

    iconDelete? user?

    Properties

    iconDelete?: boolean

    Set to true to remove the current user icon.

    user?: {
        description?: string;
        email?: string;
        icon?: { [key: string]: unknown };
        locale?: string;
        login?: string;
        name?: string;
        placeId?: number;
        timeZone?: string;
    }

    Type declaration

    • Optionaldescription?: string

      User profile description

    • Optionalemail?: string
    • Optionalicon?: { [key: string]: unknown }

      User's profile pic. Requires POST/PUT as a multipart request.

    • Optionallocale?: string

      Locale code for language/region localization. See https://github.com/inaturalist/inaturalist/tree/master/config/locales for available locales. Valid strings can be derived from file names, e.g. es-MX from es-MX.yml.

    • Optionallogin?: string
    • Optionalname?: string

      Display name for this user

    • OptionalplaceId?: number

      ID of the place for this user, customizes some common names and default search parameters

    • OptionaltimeZone?: string

      Default time zone for the user's observations. See http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html for a list of values.

    Settings

    Member Visibility

    On This Page

    Properties