Skip to main content

Create a new message

POST 
/v2/messages

Create a new message to be delivered to a patient. Messages can be associated with forms, packets, or documents. At least one of the following parameters must be provided: form, packet, or document. You can also schedule a message for future delivery.

Example request body:

{
    "patient": 123,
    "form": "abc123",
    "message_type": "form_response_request",
    "preferred_delivery_method": "email",
    "target_email": "patient@example.com",
    "scheduled_at": "2025-05-10T15:00:00Z"
}

Request​

Responses​