GuidesAPI Reference
API Reference

Create App

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

Unique Partner Product ID

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 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
Response

Updated about 13 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 13 hours ago