Create Mailer
create_mailerCreate a new email mailer for the provided event. The mailer is created inactive — use activate_mailer to start sending, or schedule_mailer for later delivery. To edit body/html of the email template, use update_email_template with the mailer's email_template_id.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | Mailer kind. Required. Immutable after create. If the user has not provided it, ask the user before proceeding. Never assume a mailer kind. | |
| name | Yes | Mailer name. Required. If the user has not provided it, ask the user before proceeding. Never invent mailer names. | |
| event_id | Yes | Event UUID returned by search_events. | |
| bcc_email | No | Optional BCC email. | |
| cc_emails | No | Optional CC emails. | |
| group_ids | No | Group UUIDs. Required when access_level is 'Group'. Use list_groups to find group IDs. | |
| tag_level | No | Promotion tag level (0 = all prospects, 1 = tagged subset). | |
| location_id | No | Optional location_id (only valid for checkin_notification kind). | |
| access_level | Yes | Mailer audience. Required. Use 'Everyone' or 'Group'. If the user has not specified it, ask the user before proceeding. Never assume an audience. | |
| email_subject | Yes | Email subject template. Required. If the user has not provided it, ask the user before proceeding. Never invent email subjects or use placeholder text. | |
| new_template_id | No | Optional email_template_id of a source template mailer to seed content from. | |
| prospect_tag_ids | No | Prospect tag IDs. Required for promotion when tag_level=1. | |
| feature_selection_id | No | FeatureSelection ID. Required for custom_form_* kinds; must be blank otherwise. | |
| include_calendar_invite | No | Attach the event's calendar invite (.ics) to every mail. Only registration_confirmation and reminder mailers carry one: it defaults to true for those and is ignored for other kinds. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hint | Yes | ||
| mailer | Yes | ||
| message | Yes |