Skip to main content
Version: 202601

Update theme global config

PATCH 

/openapi/2026-01/themes/edit-sessions/:oseid/files/:doc_id/global

Partially update the theme's global config within an edit session: pass only the settings to change (one or many). Updates the theme settings by default; pass section_id to update a global card such as the header, footer, announcement bar, or cart drawer.

Request

Path Parameters

    oseid stringrequired

    Edit session ID

    doc_id stringrequired

    Document (template file) ID

Bodyrequired

    settingsobjectrequired

    Settings to change — partial, one or many key/value pairs; other settings stay untouched

    section_idstring

    Target: omit or skin = global variables; otherwise a global section's type or stored id — the global singletons (header, footer, announcement, cart_drawer) or any member of the header / footer regions. An id that is not in the session returns 400

    template_namestring

    Render-context template name, default index

    localestring

    Render locale, default en_US

Responses

OK

Schema
    codestring

    error code

    messagestring

    error message

    data object
    sectionobject

    The stored section after the update (for skin: the changed settings echoed back)

    htmlstring

    Rendered HTML for global cards; empty for skin (no render)