Send an Email

post

https://api.servicem8.com/platform_service_email

Send an email through the ServiceM8 Messaging API.

Email Signature

You can include a staff member's email signature in your message by using the <platform-user-signature /> tag in your htmlBody or textBody. When this tag is present, the specified staff member's signature will be inserted at that location.

Important: When using the <platform-user-signature /> tag, you must include the x-impersonate-uuid header with the UUID of the staff member whose signature you want to include. Without this header, the API will return an error.

Example:

<p>Hello,</p>
<p>This is the main content of the email.</p>
<platform-user-signature />
<p>Additional footer information</p>

Note: The tag is case-insensitive.

Note: you must supply one of htmlBody or textBody in order to send a message, or you may specify both parameters. If you don't have a HTML-formatted or text-formatted version available, then simply supply the version that you do have and omit the other parameter. Submitting an empty string for either htmlBody or textBody will result in messages that cannot be viewed on some email clients.

You may specify a Reply To address, but the From address is controlled by ServiceM8.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

required

Recipient email address

string

Carbon copy recipient email address

replyTo

string

Reply-to email address

subject

string

required

Email subject line

htmlBody

string

HTML-formatted email body. At least one of htmlBody or textBody must be provided. You can use the <platform-user-signature /> tag to include a staff member's email signature at a specific location. When using the signature tag, you must include the x-impersonate-uuid header.

textBody

string

Plain text email body. At least one of htmlBody or textBody must be provided. You can use the <platform-user-signature /> tag to include a staff member's email signature at a specific location (it will be converted to plain text). When using the signature tag, you must include the x-impersonate-uuid header.

regardingJobUUID

uuid

UUID of the job that this message is regarding. This is used to link the message to the job in ServiceM8, causing the email to appear in the job diary. If you do not specify a job UUID, the message will not be linked to any job.

attachments

array of uuids

Array of attachment UUIDs to include with the email. Each UUID must reference an existing attachment in the system.

attachments

Headers

x-impersonate-uuid

uuid

UUID of the staff member to impersonate when using the <platform-user-signature /> tag. This header is required if you include the signature tag in your email body.

Responses

200Success

400Error

429Too Many Requests