HIhint
CommunicationAuthorization

Set Communication Authorization

Changed on

Sets the marketing authorization state for an email address. The email is normalized and resolved to the practice's shared email identity (created if it doesn't exist yet). Each email has exactly one authorization state, shared by every patient and prospect record that uses it.

post/provider/communication_authorizations

Request

  • Base URL
    https://api.sandbox.hint.com/api
  • URL
    https://api.sandbox.hint.com/api/provider/communication_authorizations
  • Auth
    API key in header AUTHORIZATION

Request body

emailstring required

The email address to set authorization for. Normalized (downcased and trimmed).

statestring required

opted_in or opted_out.

Response

Successful response

idstring
statestring
sourcestring
emailstring
updated_atstring date-time

Changes