@seamapi/http - v2.1.0
    Preparing search index...

    Type Alias WorkspacesCreateParameters

    type WorkspacesCreateParameters = {
        company_name?: string;
        connect_partner_name?: string;
        connect_webview_customization?: {
            logo_shape?: "circle" | "square";
            primary_button_color?: string;
            primary_button_text_color?: string;
            success_message?: string;
        };
        is_sandbox?: boolean;
        name: string;
        organization_id?: string;
        webview_logo_shape?: "circle"
        | "square";
        webview_primary_button_color?: string;
        webview_primary_button_text_color?: string;
        webview_success_message?: string;
    }
    Index
    company_name? connect_partner_name? connect_webview_customization? is_sandbox? name organization_id? webview_logo_shape? webview_primary_button_color? webview_primary_button_text_color? webview_success_message?
    company_name?: string

    Company name for the new workspace.

    connect_partner_name?: string

    Connect partner name for the new workspace.

    Use company_name instead.

    connect_webview_customization?: {
        logo_shape?: "circle" | "square";
        primary_button_color?: string;
        primary_button_text_color?: string;
        success_message?: string;
    }

    Connect Webview customizations for the new workspace. See also Customize the Look and Feel of Your Connect Webviews.

    Type Declaration

    is_sandbox?: boolean

    Indicates whether the new workspace is a sandbox workspace.

    name: string

    Name of the new workspace.

    organization_id?: string

    ID of the organization to associate with the new workspace.

    webview_logo_shape?: "circle" | "square"

    Use connect_webview_customization.webview_logo_shape instead.

    webview_primary_button_color?: string

    Use connect_webview_customization.webview_primary_button_color instead.

    Optionalwebview_primary_button_text_color

    webview_primary_button_text_color?: string

    Use connect_webview_customization.webview_primary_button_text_color instead.

    webview_success_message?: string

    Use connect_webview_customization.webview_success_message instead.

    Settings
    Member Visibility

    On This Page
    Properties