v1

latestOpenAPI 3.1.0Private2026-07-24196240439.2 KB

App

Create App

post/partner/products/{product_id}/app

Path parameters

product_idstring required

Unique Product ID

Request body

handshake_urlstring

URL where Hint POSTs the handshake payload during embed bootstrapping. Must be https.

localhost_handshake_urlstring

HTTP localhost URL used in place of handshake_url when the current session has localhost mode enabled. Sandbox partners only.

default_admin_rolestring

Role name to apply to hinters and to admin users by default. Must match the name of one of the entries in partner_roles.

default_non_admin_rolestring

Role name to apply to non-admin users by default. Must match the name of one of the entries in partner_roles.

prepopulate_role_mappingsboolean

When true, new practice→role mappings are prepopulated with the default role.

browser_allow_liststring[]

Browser capabilities delegated to the app's embedded iframes via the Permissions Policy allow attribute. Supported values: camera, microphone, geolocation. Defaults to [] (no delegation). The end user still sees the browser's own permission prompt for each capability. Changes apply the next time a surface is embedded — already-open surfaces must be reloaded.

Response

Successful response

idstring