GuidesAPI Reference
API Reference

Create App

post
https://api.sandbox.hint.com/api/partner/app
Body Params
string

URL where Hint POSTs the handshake payload during embed bootstrapping. Must be https (or localhost when localhost_mode is enabled).

string

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

string

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

boolean

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

partner_roles
object

Free-form object whose keys are partner-defined role names and values are free-text descriptions of each role. Example: {"admin": "Full access to all features", "clinician": "Can read patient charts and write notes"}. Alternative to partner_role_names — pick one.

partner_role_names
array of strings

Array of partner-defined role names. Use this when descriptions are not needed; descriptions default to empty strings. Alternative to partner_roles — pick one.

partner_role_names
Response

Updated 3 days 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 3 days ago