# Send a Message

Sends a message for a given patient to Hero.  It has optional parameters relating to the message being sent.

Endpoint: POST /v1/messages/send
Version: 1.0.0
Security: apiKeyAuth, practiceGroupId

## Request fields (application/json):

  - `patient_id` (string, required)
    The Hero patient the message relates to

  - `message_type` (string, required)
    Defines if the message will be sent on via Hero's comms tools, and by what method
    Enum: "hero", "sms", "email", "nhs_app"

  - `message_string` (string, required)
    Message content to be sent from Hero

  - `recipient_contact_detail` (string)
    Where the message will be sent (e.g. patient@email.com or +44 79000000000). If no value is provided a default will be picked from the patients record (for that contact method, SMS/Email).

  - `fallback_contact_detail` (string)

  - `fallback_message_type` (string)
    Enum: "sms", "email"

  - `write_to_record` (boolean)
    Flags if the message should be written to the EHR record post-approval

  - `encrypted` (any)
    Flags if the message should be encrypted

  - `snomed_code` (string)
    SNOMED code to be attached to the EHR record entry.  Default value applied if not passed and write_to_record is true

  - `snomed_term` (string)
    SNOMED term to be attached to the EHR record entry. Default value applied if not passed and write_to_record is true

  - `auto_write_to_record` (boolean)
    Param only considered if API key permissions allow. Automatically writes to the EHR record without requiring Hero admin approval

  - `task_id` (string)
    Task ID to be attached to a task

  - `attachment_uuid` (string)

  - `short_link_id` (string)

  - `assignee_id` (number)
    Optional. ID of the Admin or AdminTeam assigned to the message

  - `assignee_type` (string)
    Type of the assignee, either Admin or AdminTeam, assigned to the message

  - `send_at` (string)
    Specifies the scheduled date and time to send the message.

## Response 200 fields (application/json):

  - `message_id` (string, required)

  - `content` (string, required)

  - `created_at` (string, required)

  - `snomed_code` (string,null)

  - `write_to_record` (boolean, required)

  - `auth_token` (string,null)

  - `confirm_write_to_record_url` (string,null)

  - `submitted_by` (string,null)

  - `send_at` (string,null)


## Response 403 fields

## Response 500 fields