v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB

Send Email

Send an email to a Client.

post/communications/emails

Headers

x-api-keystring required

A valid api key. If you don't have one, please request one through the Web Integration screen.

Request body

from_emailstring

Email Address of the sender. Can be a Staff Email Address or a Business Email Address

to_emailstring

ccstring[]

List of emails to fill the CC field.

bccstring[]

List of emails to fill the Bcc field.

subjectstring required

Subject of the email.

bodystring

Body of the email.

Example request

{
  "attachments": [
    {
      "file_storage_id": 1234567891234567
    }
  ]
}

Response

Success flag and message Id, if applicable.

is_successboolean

True if email was sent with success.

email_service_email_idinteger

Id of the email if sent via SES (null if sent from mandrill)

wodify_validation_resultstring

The purpose of this attribute is to save any UserException message, that is, and user friendly message that should be shown to the end user. All methods should have, just like service actions:

Example response

{
  "email_service_email_id": 1234567891234567
}