Communicator Brand

The Communicator Brand feature allows the user to view the branding settings for your Patient Portal or Patient Information Center. The Communicator Brand Reference retrieves a practice's list of communicator brands.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Get specific communicator brand information

GET
/v1/{practiceid}/communicatorbrands/{communicatorbrandid}
Retrieves information of a specific communicator brand
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
communicatorbrandid integer communicatorbrandid

Output Parameters

Expand all
communicatorbrandid integer communicatorbrandid
fromemail string The email address that we mask the from email with.
haspatientinfocenteryn string If true, the Communicator Brand has a PIC (limited portal)
hasportalyn string If true, the Communicator Brand has a web portal.
name string Patient facing name for the Communicator Brand
Example Code

Get practice's list of communicator brands

GET
/v1/{practiceid}/communicatorbrands
Retrieves practice's list of communicator brands
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
communicatorbrandid integer communicatorbrandid
fromemail string The email address that we mask the from email with.
haspatientinfocenteryn string If true, the Communicator Brand has a PIC (limited portal)
hasportalyn string If true, the Communicator Brand has a web portal.
name string Patient facing name for the Communicator Brand
Example Code