PartnerPracticeCredential

Push Practice Credential

Changed on

The partner pushes (or rotates) the credential a practice's custom app uses to call the partner's API, for a specific installation. The credential is held on the installation's integration, so installations that share an integration (same practice + backend) share one credential. Requires the backend to be configured with issuance_mode: push.

post/partner/installations/{installation_id}/credential

Request

  • Base URL
    https://api.sandbox.hint.com/api
  • URL
    https://api.sandbox.hint.com/api/partner/installations/{installation_id}/credential
  • Auth
    API key in header AUTHORIZATION

Path parameters

installation_idstring required

Unique Installation ID

Request body

base_urlstring

The base URL the practice's app calls the partner API at.

payloadstring

The partner-issued credential payload (stored encrypted; never returned).

Response

Successful response

idstring
base_urlstring
created_atstring
deactivated_atstring
updated_atstring

Changes