NewsMAN API: transactional.messageSend

Sections

Newsman – Knowledge Base

HomeAPITransactionaltransactional.messageSend

Newsman Api Method: transactional.messageSend

Prototype: transactional.messageSend(list_id, message, recipients, params, account_id)

Description: Sends a mail message over http API. The SMTP account will be chosen based on the from address of the list or a specific account may be sent.

HTTP method: POST

Endpoint HTTP: /transactional.messageSend.json

Endpoint XML-RPC: transactional.messageSend

Return type: array

Return info: Array containing a list of dict items (email, status, reason, send_id) for each recipient

Request parameters POST

Variable	Type	Description
list_id	int\|string	The ID of the list from which to identify the SMTP account
message	array\|struct	Array containing the info of the message to be sent. The array must contain the following keys: from_name from_email html or text subject. Optional keys: headers template_engine images attachments
recipients	array\|struct	Array containing the message recipients. Each item must be an array with the following keys: email (required) name (optional, may be empty string) params (optional - key / value array with props)
params	array\|struct\|boolean	Array containing global parameters for the template. May be null or false.
account_id	string\|boolean	The id of a specific SMTP ACCOUNT through which to send (optional).

Response parameters

Parameter	Description
array	array containing a list of dict items (email, status, reason, send_id) for each recipient

Output example

[
    {
        "send_id": "xxxxx-xxxxx-xxxxx-xxxxx",
        "status": "queued",
        "reason": "",
        "email": "john@example.com"
    }
]

Response Errors

Code	Message	Description
407	Missing required param list_id	list_id param is required
407	Missing required param message	message param is required
407	Missing required param recipients	recipients param is required
407	Missing required param params	params param is required
101	Not allowed for list_id = %s	Invalid access to list_id
17001	Invalid message	Message param value is invalid
17002	Invalid recipients	Recipients param value is invalid
17003	Could not find the SMTP account	Transactional account not found
17004	The SMTP account is inactive	The transactional account is inactive
17005	Could not send message: error_reason	Could not send message

Error examples

{
    "err": true,
    "message": "Missing required param list_id",
    "code": 407
}

{
    "err": true,
    "message": "Missing required param message",
    "code": 407
}

{
    "err": true,
    "message": "Missing required param recipients",
    "code": 407
}

{
    "err": true,
    "message": "Missing required param params",
    "code": 407
}

{
    "err": true,
    "message": "Invalid message",
    "code": 17001
}

{
    "err": true,
    "message": "Invalid recipients",
    "code": 17002
}

{
    "err": true,
    "message": "Could not find the SMTP account",
    "code": 17003
}

{
    "err": true,
    "message": "The SMTP account is inactive",
    "code": 17004
}

{
    "err": true,
    "message": "Could not send message: Request error Missing name for recipient john@example.com. If empty please use empty string",
    "code": 17005
}