Skip to main content
POST
Send Message

Example Request

Example Response

Request Parameters

The /messages endpoint requires the following fields:
  • provider (required): The EHR provider ID to send the message to
  • subject (required): The subject line for the message
  • message (required): The content of the message to be sent

Authorizations

client_id
string
header
required
client_secret
string
header
required
access_token
string
header
required

Body

application/json
provider
string
required

The EHR provider ID to send the message to

subject
string
required

The subject line of the message

message
string
required

The content of the message

Response

200 - application/json

Successful response

success
boolean
message
string
message_id
string
job_id
integer