NewsMAN API: transactional.messageSendRaw

Sections

HomeAPITransactionaltransactional.messageSendRaw

Variable	Type	Description
list_id	int\|string	The ID of the list from which to identify the SMTP account
message	array\|struct
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
account_id	string\|boolean	The id of a specific SMTP ACCOUNT through which to send (optional).

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

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

Code	Message	Description
407	Missing required param list_id	list_id param is required
407	Missing required param mime_message	mime_message param is required
407	Missing required param recipients	recipients param is required
101	Not allowed for list_id = %s	Invalid access to list_id
17001	Invalid mime_message	mime_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

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

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

{
    "err": true,
    "message": "Missing required param recipients",
    "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",
    "code": 17005
}