HIhint
Product

Update Product

Changed on
patch/partner/products/{id}

Request

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

Path parameters

idstring required

Unique Product ID

Request body

namestring

Display name of the marketplace listing.

slugstring

URL-safe identifier (e.g. "my-product"). Only settable on create — contact Hint support to change it later.

type'app' | 'integration' | 'solution' | 'network'

Kind of marketplace listing. network is reserved for a partner managed by a network practice.

summarystring

Short tagline shown on the marketplace card (max 80 chars).

built_by_namestring

Display name of the maker, shown under the listing as "Built by <name>".

built_by_urlstring

Url the "Built by" link points to.

iconstring

Listing icon as a base64 data URI (e.g. "data:image/png;base64,..."). Note the field-name asymmetry: the request field is icon (data URI input); the GET response surfaces the uploaded image as icon_url (hosted URL). Sending icon_url as a request field is silently ignored. The listing icon is distinct from the Core Page sidebar icon (surface.core_page_icon) — see the surface endpoints for that.

default_charge_category_type'memberships' | 'labs' | 'medications' | 'vitamins_and_supplements' | 'vaccines' | 'imaging' | 'supplies_and_dme' | 'retail_items' | 'office_visits' | 'procedures' | 'fees'

Default charge category applied to patient charges created for this product when none is specified on the charge. Must be one of the practice's default charge categories. When unset, those charges are left Unassigned.

Response

Successful response

idstring
built_by_namestring
built_by_urlstring
default_charge_category_typestring
icon_urlstring
namestring
slugstring
summarystring

Changes

  • c9bda0d2dd87Revision changes
    • info

      added the new optional request property

    • info

      added the new network enum value to the request property

    • info

      added the optional property to the response with the status