GuidesAPI Reference
GuidesAPI Reference
GuidesAPI ReferenceLog In
API Reference

Create App

post
https://api.sandbox.hint.com/api/partner/products//app
Path Params
string
required

Unique Product ID

Body Params
string

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

string

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

string

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

string

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

boolean

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

partner_roles
array of objects

List of partner-defined roles. Each entry has a name (unique, required) and a description (free text, optional).

partner_roles
browser_allow_list
array of strings

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.

browser_allow_list
Response

Updated about 9 hours ago

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

Updated about 9 hours ago