Set card properties

PATCH 
/openapi/2026-01/themes/edit-sessions/:oseid/sections/:section_id/props

Set/merge properties into a card's settings within an edit session.

Request

Path Parameters

oseid stringrequired

Edit session ID

section_id stringrequired

Section instance ID inside the document; a global card id (header, footer, announcement, cart_drawer) also works

application/json

Body

Bodyrequired

doc_idstringrequired

Document (template file) ID the section lives in

theme_idstringrequired

Theme ID (used to build the rendering context url)

propsobjectrequired

Key→value properties to set/merge into the section's settings

template_namestring

Template name, e.g. index. Defaults to the file location without .liquid

localestring

Rendering locale; defaults to en_US

Example

json

{
  "doc_id": "string",
  "theme_id": "string",
  "props": {},
  "template_name": "string",
  "locale": "string"
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

sectionobject

The updated section object

htmlstring

Rendered section HTML. Empty when the target is a global card (header / footer / ...) — those are not re-rendered per section

Example

json

{
  "code": "string",
  "message": "string",
  "data": {
    "section": {},
    "html": "string"
  }
}