Create App Surface

Path Params
string
required

Unique Product ID

Body Params
string
enum
required
Allowed:
string
required
string

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

string

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.

string

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.

boolean
string
string
string
string

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.

string

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.

string
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json