Sends one general email template (from GET /email-templates) for one record. item_id must be the ID of a record of the template's item_type, for example a repair order ID for a fleets.repair_orders template. The email (or text message, for SMS templates) is queued: a successful response means it was accepted, not delivered.The response is the same whether or not anything is sent. The template's own rules are checked first, and nothing is sent when:
no record of the template's item_type has that item_id;
the template is limited to records created by staff, or to records created online, and the record does not match;
the template only sends on public (website) actions: an API call never matches;
the template does not send more than once per record and was already sent for this record;
the record was created before the template's start date;
the template's conditions do not match the record;
there are no recipients (no email address, or no mobile number for SMS templates).
Recipients are the users selected on the template; otherwise, for emails, the email fields selected on it; otherwise the default recipients of that kind of record.
Request
Authorization
Path Params
Header Params
Responses
🟢200OK
application/json
The request was accepted. success is true even when the template's rules prevented the send. HTTP 200 is also used for failures: always check success. When it is false, the body is an ErrorUnauthorized (status_code 401 or 403).