Disable app embed

POST 
/openapi/2026-01/themes/edit-sessions/:oseid/apps/disable

Disable a specific app-embed block or script tag within an edit session.

Request

Path Parameters

oseid stringrequired

Edit session ID

application/json

Body

Bodyrequired

doc_idstring

Document (template file) ID containing the skin section. Optional; empty -> server resolves index.liquid

theme_idstringrequired

Theme ID whose app switches are updated; also resolves the default document and the rendering context

categorystring

Category: app_embeds or script_tags. Optional; only used to disambiguate when block_id is not unique

app_keystring

App grouping key. Optional; empty -> server searches all groups by block_id

block_idstringrequired

Block identifier: type field for app_embeds, id field for script_tags

template_namestring

Render-context template name; defaults to index

localestring

Rendering locale; defaults to en_US

Example

json

{
  "doc_id": "string",
  "theme_id": "string",
  "category": "string",
  "app_key": "string",
  "block_id": "string",
  "template_name": "string",
  "locale": "string"
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object
object

Example

json

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