Communications POST API Documentation

Purpose

This API is used to send email communications from a specific account. It allows attaching files, specifying recipients, and including CC/BCC addresses, subject lines, and body content. The endpoint handles email composition, file upload, and delivery, while automatically tracking communication records within the system.

Use Case

This API is typically used in scenarios where automated or manual email correspondence must be logged against a customer account.
Examples include:

Sending invoices, quotes, or other business documents directly from the system.
Logging customer communication for audit or CRM tracking.
Managing centralized communication history related to a specific account.

Path Parameters

Parameter	Type	Description
account_uuid	string	Unique identifier of the account for which the email is being sent.

Query Parameters

This endpoint does not accept any query parameters.

Request Body

The request body must be sent as form-data.

Attribute	Type	Description
attachment	file	The file to be attached with the email (example: PDF, DOCX, PNG).
to	string	Primary recipient’s email address.
cc	string	Comma-separated list of CC email addresses.
bcc	string	Comma-separated list of BCC email addresses.
subject	string	The subject line of the email.
body	string	The main content or message body of the email.

Response

Upon successful submission, the response confirms that the email communication has been created and stored in the account’s communication records. It includes metadata about the sent message such as UUID, sender, recipients, timestamps, and attachment details. Each attachment entry provides file name, storage path, size, and MIME type, enabling easy retrieval or download later. This ensures every outgoing email is traceable within the account’s communication history and complies with record-keeping requirements.

Response Body

                JSON
              

                      {
    "account": {
        "communication": {
            "email": {
                "uuid": "EMAIL_UUID",
                "message_type": "MESSAGE_TYPE",
                "status": "STATUS",
                "from": "SENDER_EMAIL",
                "to": "RECIPIENT_EMAIL",
                "cc": [
                    "CC_EMAIL_1",
                    "CC_EMAIL_2"
                ],
                "bcc": [
                    "BCC_EMAIL_1",
                    "BCC_EMAIL_2"
                ],
                "subject": "EMAIL_SUBJECT",
                "body": "EMAIL_BODY",
                "additional_template": "ADDITIONAL_TEMPLATE_NAME",
                "created_at": "CREATED_TIMESTAMP",
                "last_updated_at": "LAST_UPDATED_TIMESTAMP",
                "attachments": [
                    {
                        "name": "ATTACHMENT_NAME",
                        "path": "ATTACHMENT_PATH",
                        "size": "ATTACHMENT_SIZE",
                        "type": "ATTACHMENT_MIME_TYPE"
                    }
                ]
            }
        }
    }
}

                    

Attribute	Type	Description
account	object	Represents the account to which the email communication is linked.
account.communication	object	Contains details about all communications for the account.
account.communication.email	object	Contains data specific to the email communication just sent.
account.communication.email.uuid	string	Unique identifier of the email record.
account.communication.email.message_type	string	Type of message sent (example: SENT, RECEIVED).
account.communication.email.status	string	Current status of the message (example: ACTIVE).
account.communication.email.from	string	Sender’s email address.
account.communication.email.to	string	Recipient’s email address.
account.communication.email.cc	array	List of CC recipients.
account.communication.email.bcc	array	List of BCC recipients.
account.communication.email.subject	string	Subject line of the email.
account.communication.email.body	string	Body content of the email message.
account.communication.email.additional_template	string	Name of any additional email template used (if applicable).
account.communication.email.created_at	string	Timestamp when the email record was created.
account.communication.email.last_updated_at	string	Timestamp when the email record was last updated.
account.communication.email.attachments	array	List of attached files included in the email.
account.communication.email.attachments[].name	string	File name of the attached document.
account.communication.email.attachments[].path	string	Server storage path of the attached file.
account.communication.email.attachments[].size	integer	File size of the attachment (in bytes).
account.communication.email.attachments[].type	string	MIME type of the attached file.