Triggers a configured mailing (send_id) and sends it to a specific subscriber.
The request body is an array of mailing objects. Each object must include a numeric
send_id and a contactid. Additional fields are merged into the mailing data before
processing.
Force-send behaviour
This endpoint bypasses scheduling and mailing-state checks. The mailing is sent
regardless of its send_active flag, send_status (even if already sent), or
send_date. The mailing record is used as a template only.
The only guard that can prevent sending is the subscriber's active status: if the
subscriber is not in an active state (active ∉ 1, 3, 4, 6), the send is skipped
silently and the response returns sent: 0.
Fields
| Field | Required | Description |
|---|---|---|
send_id | Yes | ID of the configured mailing to use as a template |
contactid | Yes | Subscriber record ID to send to. If omitted, no email is sent (returns sent: 0 without error). |
mssys_text_content_part | No | Injected into the email where the merge tag [mssys_text_content_part] appears in the letter template (plain-text part). Has no effect if the merge tag is absent from the template. |
mssys_html_content_part | No | Injected into the email where the merge tag [mssys_html_content_part] appears in the letter template (HTML part). Has no effect if the merge tag is absent from the template. |
Any other fields accepted by the mailing system can also be passed and will be merged
into the mailing data.
Using mssys_text_content_part / mssys_html_content_part
mssys_text_content_part / mssys_html_content_partThese fields work as merge tag substitutions, not full-body overrides. The letter
template (set up in the admin UI) must contain the corresponding merge tag where the
dynamic content should appear:
- To let the API control the entire email body, create a skeleton letter whose HTML
body is just[mssys_html_content_part]and whose text body is just
[mssys_text_content_part]. - To inject content into a specific section of an existing template, place
[mssys_html_content_part]at the desired location in the template.
Error codes
| Code | Meaning |
|---|---|
| 10101 | Body is not an array, or send_id is not numeric |
| 10102 | send_id does not belong to the authenticated account |
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||