/v1/comms/send/previewPreview a send to an address
What post_comms_send would do with the SAME body, and nothing is sent or saved: medium, from (our line it leaves on — the one named, else the one the send would choose; "" is no particular line), who it reaches (contact_identifier, contact_name), conversation_id (the thread it lands on, null when the send would open one), parent_message_id (the message an email goes as a reply to — a mail to an address the workspace already writes to replies on that thread), 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 the send would refuse — a line the caller may not send from, a template field with no value, an email with no words — is refused here in the same words.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Request body
application/jsonrequiredResponses
the action's answer
{
"bcc": [
"string"
],
"body": "string",
"body_html": "string",
"cc": [
"string"
],
"contact_identifier": "string",
"contact_name": "string",
"from": "string",
"medium": "string",
"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"
}