academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Emails → Sends an email to students or staff members of the university. The delivery of the email can take up to several minutes, and only general placeholders are replaced during delivery.

AI-generated

Summary

Send an email to selected students or staff members, using profile IDs and/or email addresses as recipients. Provide a sender and body content type; optionally set a template, subject, body, language for general placeholder replacement, BCC address, and attachments. Delivery may take several minutes.

Inputs

  • profileIds — One or more recipient profile IDs.
  • emailAddresses — One or more recipient email addresses.
  • sender (required) — Sender in Display Name <email@example.com> format.
  • templateId — ID of a text template to use for the email body.
  • subject — Email subject line.
  • content — Email body content.
  • contentType (required) — Body format: text or html.
  • language — Language for general placeholder replacement: de or en.
  • bccEmailAddress — BCC recipient email address.
  • attachments — Zero or more attachments, each with a file name and Base64-encoded file content.

Output shape

A list of JSON response items from the API, paired with their input item.

The operation makes an authenticated API request. The source does not specify the response fields or whether the API returns a body for this operation. If Continue On Fail is enabled, request errors are returned as items with an error field.

Links

Discussion