/v1/comms/conversations/{id}/messages/previewPreview a message on a conversation
What post_comms_conversations_id_messages would do with the SAME body, and nothing is sent or saved: medium, from (our line it leaves on, as the thread will carry it; "" is no particular line), the other side (contact_identifier, contact_name), conversation_id, parent_message_id (the earlier message an email is threaded under, null for a new one), the words as they will go (subject, body, body_html, with any template_id filled) and signature (the HTML the send appends, "" for none — a text is never signed). Decided by the send's own rule, so the send then does exactly this. Whatever that send would refuse is refused here in the same words. To send it, call post_comms_conversations_id_messages itself.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Request body
application/jsonrequiredResponses
the action's answer
{
"bcc": [
"string"
],
"body": "string",
"body_html": "string",
"cc": [
"string"
],
"contact_identifier": "string",
"contact_name": "string",
"conversation_id": 1,
"from": "string",
"medium": "string",
"parent_message_id": 1,
"reply_subject": "string",
"signature": "string",
"subject": "string"
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}