Create conversation
POST {{baseUrl}}/conversations?subdomain={{subdomain}}&location_id={{location_id}}
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
subdomain | string | (Required) Used to scope the request to the specified institution | |
location_id | string | (Required) Used to scope the request to the specified location |
Request Body
{"recipient_ids"=>["<integer>", "<integer>"], "message"=>{"body"=>"<string>"}, "assigned_user_id"=>"<integer>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"code":"\u003cboolean\u003e","description":"\u003cstring\u003e","error":["\u003cstring\u003e","\u003cstring\u003e"],"data":[{"conversation":{"id":"\u003cinteger\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","patient":{"id":"\u003cinteger\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","name":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","bio":"\u003cobject\u003e","inactive":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","guarantor_id":"\u003cinteger\u003e","unsubscribe_sms":"\u003cboolean\u003e"}},"message":{"id":"\u003cinteger\u003e","body":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","conversation_id":"\u003cinteger\u003e","seen_by":["\u003cstring\u003e","\u003cstring\u003e"],"user_id":"\u003cinteger\u003e","attachment_file_name":"\u003cstring\u003e","attachment_content_type":"\u003cstring\u003e","attachment_file_size":"\u003cinteger\u003e","attachment_updated_at":"\u003cstring\u003e","sms_msg_id":"\u003cinteger\u003e","sender_info":{"name":"\u003cstring\u003e","image":"\u003cstring\u003e","meta_type":"\u003cstring\u003e","user_id":"\u003cinteger\u003e"},"attachment_url":"\u003cstring\u003e","is_custom_reminder_response":"\u003cboolean\u003e","created_at_with_tz":"\u003cstring\u003e","timezone_offset":"\u003cstring\u003e"}},{"conversation":{"id":"\u003cinteger\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","patient":{"id":"\u003cinteger\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","name":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","bio":"\u003cobject\u003e","inactive":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","guarantor_id":"\u003cinteger\u003e","unsubscribe_sms":"\u003cboolean\u003e"}},"message":{"id":"\u003cinteger\u003e","body":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","conversation_id":"\u003cinteger\u003e","seen_by":["\u003cstring\u003e","\u003cstring\u003e"],"user_id":"\u003cinteger\u003e","attachment_file_name":"\u003cstring\u003e","attachment_content_type":"\u003cstring\u003e","attachment_file_size":"\u003cinteger\u003e","attachment_updated_at":"\u003cstring\u003e","sms_msg_id":"\u003cinteger\u003e","sender_info":{"name":"\u003cstring\u003e","image":"\u003cstring\u003e","meta_type":"\u003cstring\u003e","user_id":"\u003cinteger\u003e"},"attachment_url":"\u003cstring\u003e","is_custom_reminder_response":"\u003cboolean\u003e","created_at_with_tz":"\u003cstring\u003e","timezone_offset":"\u003cstring\u003e"}}],"count":"\u003cinteger\u003e"}