NAV Navbar
Logo cerner
Ruby Shell

Consumer Notification API v1

The HealtheIntent Consumer Notification API allows you to contact consumers about notifiable events related to their health or medical care, for example, notifications about available bills, updates to electronic health records (EHRs), or new messages from clinicians. The Notifiable Events endpoints allow you to manage the list of events for which a consumer can be notified, and the Notifications endpoint allows you to create a notification for a notifiable event. The API currently can be used to send notifications to consumers using email, mobile push notifications, and short message service (SMS). Consumers can elect to receive or to not receive notifications based on the type of notifiable event and the delivery mechanism.

URL: https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1

Notifiable Events

Notifiable events are events that consumers may want to be notified of, for example, an available bill, an update to their EHR, or a new message.

Create a Notifiable Event

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/notifiable-events', headers: headers, body: {"name":"Secure Message","translations":[{"locale":"en-US","displayName":"Radiology Report","description":"Sign up to receive the latest news related to the wellness program."}]}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/notifiable-events \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Secure Message","translations":[{"locale":"en-US","displayName":"Radiology Report","description":"Sign up to receive the latest news related to the wellness program."}]}

POST /notifiable-events

Creates a notifiable event and one or more translations associated with the notifiable event.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postNotifiableEvents true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created NotifiableEvent
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Response Headers

Status Header Type Format Description
201 Location string The location of the notifiable event.

Retrieve a List of Notifiable Events

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/notifiable-events', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/notifiable-events \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "91682e64-f541-45bf-a892-64725461fdcc",
      "name": "Secure Message",
      "translations": [
        {
          "locale": "en-US",
          "displayName": "Radiology Report",
          "description": "Sign up to receive the latest news related to the wellness program."
        }
      ],
      "createdAt": "2018-05-15T12:23:12Z",
      "updatedAt": "2018-05-15T12:23:12Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/api/v1/consumer-notifications/notifiable-events?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/api/v1/consumer-notifications/notifiable-events?offset=0&limit=20"
}

GET /notifiable-events

Retrieves a list of the different types of events for which notifications can be sent.

Parameters

Parameter In Type Required Default Description Accepted Values
locale query string false N/A Retrieves only the notification event’s translation for the specified locale, if it exists. -
name query string false N/A Retrieves the notifiable event with the exactly matching name. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success NotifiableEvents
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Delete a Notifiable Event

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/notifiable-events/{notifiableEventId}', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/notifiable-events/{notifiableEventId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /notifiable-events/{notifiableEventId}

Removes a single notifiable event and its translations from the system.

Parameters

Parameter In Type Required Default Description Accepted Values
notifiableEventId path string true N/A The ID of the notifiable event. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a Notifiable Event

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.patch('https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/notifiable-events/{notifiableEventId}', headers: headers, body: {"name":"Secure Message","translations":[{"locale":"en-US","displayName":"Radiology Report","description":"Sign up to receive the latest news related to the wellness program."}]}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X PATCH https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/notifiable-events/{notifiableEventId} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Secure Message","translations":[{"locale":"en-US","displayName":"Radiology Report","description":"Sign up to receive the latest news related to the wellness program."}]}

PATCH /notifiable-events/{notifiableEventId}

Updates the name or translations of a notifiable event. The update behavior follows the RFC 7396 JSON Merge Patch standard on the Internet Engineering Task Force (IETF) website.

Note: The link above is to an external resource. This resource is provided for reference purposes and should be used with caution. Contact your Cerner support team for more information about third-party content.

Parameters

Parameter In Type Required Default Description Accepted Values
notifiableEventId path string true N/A The ID of the notifiable event. -
body body patchNotifiableEvents true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a Single Notifiable Event

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/notifiable-events/{notifiableEventId}', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/notifiable-events/{notifiableEventId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "91682e64-f541-45bf-a892-64725461fdcc",
  "name": "Secure Message",
  "translations": [
    {
      "locale": "en-US",
      "displayName": "Radiology Report",
      "description": "Sign up to receive the latest news related to the wellness program."
    }
  ],
  "createdAt": "2018-05-15T12:23:12Z",
  "updatedAt": "2018-05-15T12:23:12Z"
}

GET /notifiable-events/{notifiableEventId}

Retrieves the information for a single notifiable event by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
notifiableEventId path string true N/A The ID of the notifiable event. -
locale query string false N/A Retrieves only the notification event’s translation for the specified locale, if it exists. -

Response Statuses

Status Meaning Description Schema
200 OK Success NotifiableEvent
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Notifications

A notification is a message sent to a consumer to inform them that an event has occurred. The message can be sent using multiple delivery mechanisms. Currently, the API supports the email, push notification, and SMS delivery mechanisms.

Send a Notification to a Consumer

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/notifiable-events/{notifiableEventId}/notifications', headers: headers, body: {"emailSubject":"John, a new lab result is ready to view.","emailHTML":"<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n<meta charset=\"utf-8\" />\n</head>\n<body>\n<p>Hi John,</p>\n<p>A lab result for Jane Smith is now available for you to view. Visit www.cerner.com to review this information.</p>\n<p>Notes: Because protecting the privacy of your health information is important to us, we have made this process extremely secure. The email provided to you should be kept confidential. Do not reply to this message, as it was sent from an unmonitored email inbox.</p>\n</body>\n</html>","emailPlainText":"Hi John,\n A lab result for Jane Smith is now available for you to view. Visit www.cerner.com to review this information. \n Notes: Because protecting the privacy of your health information is important to us, we have made this process extremely secure. The email provided to you should be kept confidential. Do not reply to this message, as it was sent from an unmonitored email inbox.","pushSubject":"Lab Result","pushBody":"A new lab result is available to view.","smsBody":"A new lab result is ready to view at www.cerner.com. View your profile to edit your message settings.","consumer":{"id":"90baba1a-8bde-4a93-aed1-feb56f333039"}}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/notifiable-events/{notifiableEventId}/notifications \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"emailSubject":"John, a new lab result is ready to view.","emailHTML":"<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n<meta charset=\"utf-8\" />\n</head>\n<body>\n<p>Hi John,</p>\n<p>A lab result for Jane Smith is now available for you to view. Visit www.cerner.com to review this information.</p>\n<p>Notes: Because protecting the privacy of your health information is important to us, we have made this process extremely secure. The email provided to you should be kept confidential. Do not reply to this message, as it was sent from an unmonitored email inbox.</p>\n</body>\n</html>","emailPlainText":"Hi John,\n A lab result for Jane Smith is now available for you to view. Visit www.cerner.com to review this information. \n Notes: Because protecting the privacy of your health information is important to us, we have made this process extremely secure. The email provided to you should be kept confidential. Do not reply to this message, as it was sent from an unmonitored email inbox.","pushSubject":"Lab Result","pushBody":"A new lab result is available to view.","smsBody":"A new lab result is ready to view at www.cerner.com. View your profile to edit your message settings.","consumer":{"id":"90baba1a-8bde-4a93-aed1-feb56f333039"}}

POST /notifiable-events/{notifiableEventId}/notifications

Sends a notification to the consumer as an email, mobile push notification, or SMS. The API can send the same notification to the consumer using multiple delivery mechanisms. The following mechanisms are available:

This endpoint retrieves the consumer’s first email address and phone number from the Consumer API. Cerner does not recommend using this endpoint to manage a consumer’s email address and phone number; instead, the consumer can manage their own contact information using the HealtheLife application. If no email address or phone number exists, no notification is sent by that delivery mechanism. The consumer must opt in to receive notifications for a notifiable event by setting their consumer notification preferences for each delivery mechanism.

Note: SMS notification messages should be less than 114 characters; if the message is greater than 114 characters, the message is sent as multiple messages to the consumer.

Parameters

Parameter In Type Required Default Description Accepted Values
notifiableEventId path string true N/A The ID of the notifiable event. -
body body postNotifiableEventsNotifiableeventidNotifications true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Consumer Preferences

Consumers can set preferences to determine how they want to be notified. A consumer preference specifies which notifiable events the consumer wants to be notified about and which delivery mechanisms they want to be used to notify them about those events, if any. For example, a consumer might prefer to be notified about EHR updates by SMS and push notifications but prefer to be notified about new messages by only email. When sending a notification for a notifiable event, the API checks the consumer preference for the type of event. The API then attempts to send a notification using every delivery mechanism through which the consumer has chosen to receive notifications. If the consumer has selected ‘false’ for all the delivery mechanisms, no notification is sent.

Delete a Consumer Notification Preference

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences/{preferenceId}', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences/{preferenceId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /consumers/{consumerId}/preferences/{preferenceId}

Deletes a consumer’s notification preference using the consumer’s notification preference ID.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of the consumer. -
preferenceId path string true N/A The ID of the preference. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a Consumer Notification Preference

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.patch('https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences/{preferenceId}', headers: headers, body: {"desiresEmail":true,"desiresSms":true,"desiresPush":true}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X PATCH https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences/{preferenceId} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"desiresEmail":true,"desiresSms":true,"desiresPush":true}

PATCH /consumers/{consumerId}/preferences/{preferenceId}

Updates a consumer’s notification preference using the specified body parameters and the consumer’s notification preference ID. The update behavior follows the RFC 7396 JSON Merge Patch standard on the IETF website.

Note: The link above is to an external resource. This resource is provided for reference purposes and should be used with caution. Contact your Cerner support team for more information about third-party content.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of the consumer. -
preferenceId path string true N/A The ID of the preference. -
body body patchConsumersConsumeridPreferences true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a Single Consumer Notification Preference

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences/{preferenceId}', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences/{preferenceId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "f89fa3dd-0000-494b-1111-4640ccc081e3",
  "notifiableEvent": {
    "id": "5ecaf544-01d5-01kf-95hj-8e2bcec12006"
  },
  "desiresEmail": true,
  "desiresSms": true,
  "desiresPush": true,
  "createdAt": "2018-05-15T12:23:12Z",
  "updatedAt": "2018-05-15T12:23:12Z"
}

GET /consumers/{consumerId}/preferences/{preferenceId}

Retrieves a single consumer notification preference.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of the consumer. -
preferenceId path string true N/A The ID of the preference. -

Response Statuses

Status Meaning Description Schema
200 OK Success Preference
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Create a Consumer Notification Preference

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences', headers: headers, body: {"desiresEmail":true,"desiresSms":true,"desiresPush":true,"notifiableEvent":{"id":"5ecaf544-01d5-01kf-95hj-8e2bcec12006"}}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"desiresEmail":true,"desiresSms":true,"desiresPush":true,"notifiableEvent":{"id":"5ecaf544-01d5-01kf-95hj-8e2bcec12006"}}

POST /consumers/{consumerId}/preferences

Creates a consumer notification preference with the specified body parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of the consumer. -
body body postConsumersConsumeridPreferences true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created Preference
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Response Headers

Status Header Type Format Description
201 Location string The location of the preference.

Retrieve a List of Consumer Notification Preferences

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/consumer-notifications/v1/consumers/{consumerId}/preferences \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "f89fa3dd-0000-494b-1111-4640ccc081e3",
      "notifiableEvent": {
        "id": "5ecaf544-01d5-01kf-95hj-8e2bcec12006"
      },
      "desiresEmail": true,
      "desiresSms": true,
      "desiresPush": true,
      "createdAt": "2018-05-15T12:23:12Z",
      "updatedAt": "2018-05-15T12:23:12Z"
    }
  ]
}

GET /consumers/{consumerId}/preferences

Retrieves a list of all notification preferences for a consumer.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId path string true N/A The ID of the consumer. -
desiresEmail query boolean false N/A Filters consumer preferences by desiresEmail. -
desiresSms query boolean false N/A Filters consumer preferences by desiresSms. -
desiresPush query boolean false N/A Filters consumer preferences by desiresPush. -
notifiableEventId query string false N/A Filters consumer preferences by notifiable event ID. -
notifiableEventName query string false N/A Filters consumer preferences by notifiable event name. -

Response Statuses

Status Meaning Description Schema
200 OK Success Preferences
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Schema Definitions

postNotifiableEvents

Name Type Required Description Accepted Values
name string true The human-readable name of the notifiable event. This is used as the display name if no translation exists in the user’s locale. -
translations [object] true The translated display name and description of the notifiable event. -
» locale string true Subtags from the language subtag registry on the Internet Assigned Numbers Authority (IANA) website, formatted according to the RFC 5646 Tags for Identification Languages standard on the IETF website. Note: The links above are to external resources. These resources are provided for reference purposes and should be used with caution. Contact your Cerner support team for more information about third-party content. -
» displayName string true The translated display name of the notifiable event. When creating a translation for a new locale, this field is required. -
» description string false The translated text that describes the notifiable event. -

NotifiableEvent

Name Type Required Description Accepted Values
id string false The ID of the notifiable event. -
name string false The human-readable name of the notifiable event. This is used as the display name if no translation exists in the user’s locale. -
translations [Translation] false The translated display name and description of the notifiable event. -
createdAt string(date-time) false When the notifiable event was created, in International Organization for Standardization (ISO) 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string(date-time) false When the notifiable event was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -

Translation

Name Type Required Description Accepted Values
locale string false Subtags from the language subtag registry on the Internet Assigned Numbers Authority (IANA) website, formatted according to the RFC 5646 Tags for Identification Languages standard on the IETF website. Note: The links above are to external resources. These resources are provided for reference purposes and should be used with caution. Contact your Cerner support team for more information about third-party content. -
displayName string false The translated display name of the notifiable event. When creating a translation for a new locale, this field is required. -
description string false The translated text that describes the notifiable event. -

Error

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [ErrorDetail] false A list of additional error details. -

ErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

NotifiableEvents

Name Type Required Description Accepted Values
items [NotifiableEvent] true Retrieves the information for a single notifiable event by ID. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

patchNotifiableEvents

Name Type Required Description Accepted Values
name string false The human-readable name of the notifiable event. This is used as the display name if no translation exists in the user’s locale. -
translations [object] false The translated display name and description of the notifiable event. -
» description string false The translated text that describes the notifiable event. -
» displayName string false The translated display name of the notifiable event. When creating a translation for a new locale, this field is required. -
» locale string true Subtags from the language subtag registry on the Internet Assigned Numbers Authority (IANA) website, formatted according to the RFC 5646 Tags for Identification Languages standard on the IETF website. Note: The links above are to external resources. These resources are provided for reference purposes and should be used with caution. Contact your Cerner support team for more information about third-party content. -

postNotifiableEventsNotifiableeventidNotifications

Name Type Required Description Accepted Values
emailSubject string false The subject of the email. This field is required to send email notifications. The maximum length is 889 characters. -
emailHTML string false The HTML content of the email. Either the {emailHTML} or {emailPlainText} field is required to send email notifications. Both fields can be used in the same request. -
emailPlainText string false The plain text content of the email. Either the {emailHTML} or {emailPlainText} field is required to send email notifications. Both fields can be used in the same request. -
pushSubject string false The subject of the mobile push notification. This field is required to send mobile push notifications. The maximum length is 40 characters. -
pushBody string false The text content of the mobile push notification. This field is required to send mobile push notifications. The maximum length is 1000 characters. -
smsBody string false The text content of the SMS message. This field is required to send SMS message notifications. The maximum length is 456 characters. -
consumer object true A JSON object that represents a consumer. -
» id string true The ID of the consumer. -

patchConsumersConsumeridPreferences

Name Type Required Description Accepted Values
desiresEmail boolean false Indicates whether the consumer wants to be notified by email. If true, a consumer will receive notifications for the corresponding notifiable event by email. -
desiresSms boolean false Indicates whether the consumer wants to be notified by SMS. If true, a consumer will receive notifications for the corresponding notifiable event by SMS. -
desiresPush boolean false Indicates whether the consumer wants to be notified by push. If true, a consumer will receive notifications for the corresponding notifiable event by push. -

Preference

Name Type Required Description Accepted Values
id string false The ID of a single consumer’s notification preference. -
notifiableEvent object false A JSON object that represents a notifiable event. -
» id string false The ID of the notifiable event. -
desiresEmail boolean false Indicates whether the consumer wants to be notified by email. If true, a consumer will receive notifications for the corresponding notifiable event by email. The default is false. -
desiresSms boolean false Indicates whether the consumer wants to be notified by SMS. If true, a consumer will receive notifications for the corresponding notifiable event by SMS. The default is false. -
desiresPush boolean false Indicates whether the consumer wants to be notified by push notifications from the HealtheLife mobile app. If true, a consumer will receive notifications for the corresponding notifiable event by push. The default is false. -
createdAt string(date-time) false When a consumer’s notification preference was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string(date-time) false When a consumer’s notification preference was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -

postConsumersConsumeridPreferences

Name Type Required Description Accepted Values
desiresEmail boolean false Indicates whether the consumer wants to be notified by email. If true, a consumer will receive notifications for the corresponding notifiable event by email. The default is false. -
desiresSms boolean false Indicates whether the consumer wants to be notified by SMS. If true, a consumer will receive notifications for the corresponding notifiable event by SMS. The default is false. -
desiresPush boolean false Indicates whether the consumer wants to be notified by push notifications from the HealtheLife mobile app. If true, a consumer will receive notifications for the corresponding notifiable event by push. The default is false. -
notifiableEvent object true A JSON object that represents a notifiable event. -
» id string false The ID of the notifiable event. -
» name string false The name of the notifiable event. -

Preferences

Name Type Required Description Accepted Values
items [Preference] false A list of consumer preferences. -
Ruby Shell