v1

latestOpenAPI 3.1.0Private2026-07-24196240439.2 KB

AppSurface

Update App Surface

patch/partner/products/{product_id}/app/surfaces/{id}

Path parameters

product_idstring required

Unique Product ID

idstring required

Unique App Surface ID

Request body

source_urlstring

localhost_source_urlstring

HTTP localhost URL used in place of source_url when the requesting browser session has localhost mode enabled. Sandbox partners only.

core_page_iconstring

Base64-encoded data URI of the icon image (e.g. data:image/png;base64,...). Max 5MB. Used only for core_page surfaces. Note the field-name asymmetry: the request field is core_page_icon (data URI input); the GET response surfaces the uploaded image as core_page_icon_url (hosted URL). Sending core_page_icon_url as a request field is silently ignored.

core_page_icon_labelstring

Sidebar text shown next to the icon — tooltip on hover on desktop, visible text on mobile sidebars. Recommended ≤14 characters (longer labels overflow the nav rail). Used only for core_page surfaces.

core_page_auto_adjust_heightboolean

interaction_titlestring

interaction_descriptionstring

interaction_typestring

clinical_chart_iconstring

Base64-encoded data URI of the icon image (e.g. data:image/png;base64,...). Max 5MB. Used only for clinical_chart surfaces. Note the field-name asymmetry: the request field is clinical_chart_icon (data URI input); the GET response surfaces the uploaded image as clinical_chart_icon_url (hosted URL). Sending clinical_chart_icon_url as a request field is silently ignored.

clinical_chart_icon_labelstring

Sidebar text shown next to the icon — tooltip on hover on desktop, visible text on mobile sidebars. Recommended ≤14 characters. Used only for clinical_chart surfaces.

settings_labelstring

Response

Successful response

idstring