| Nombreremitente | string Example: Nombreremitente=My name Name of the Email sender.
|
| Emailremitente required | string Example: Emailremitente=minombre@micorreo.com Sender of the Email. It must be a valid email and the domain must have been validated in your account, with the SPF and DKIM records added to your DNS and operation verified.
|
| Replyto | string Example: Replyto=minombre@micorreo.com Email to which the recipient will reply.
|
| Destinatarios required | Array of arrays Example: Destinatarios=[{"Nombre":"Pedro Pérez","Email":"destinatario@eldominio.com","Variables":[{"Nombre":"Motivo","Valor":"Felicitarte"},{"Nombre":"Razon","Valor":"Tu 25 cumpleaños"]}] JSON array with the recipients of the email. You can add variables if you want to personalize Subject and Message per recipient.
For example:
[
{
"Nombre": "Pedro Aicart",
"Email": "pedro@dominio.com",
"Referencia": "12345678T",
"Variables": [
{
"Nombre": "Accion",
"Valor": "Transferencia"
},
{
"Nombre": "Importe",
"Valor": "10.000"
},
]
},
{
"Nombre": "Ana Aguado",
"Email": "ana@empresa.com",
"Referencia": "36578294H",
"Variables": [
{
"Nombre": "Accion",
"Valor": "Devolución"
},
{
"Nombre": "Importe",
"Valor": "127"
},
]
}
]
|
| Asunto required | string Example: Asunto=This is a message for ###Nombre### on the occasion of ###motivo### |
| Plantilla | integer Example: Plantilla=1234567 The Id of the template you have created within the user panel. It is an optional parameter, you can send the HTML directly in Message or send this data to reference the template created in the panel. The variables within the template must be of the type ###Variabel### which will then be personalized per recipient. See the Message parameter to review the reserved variables.
|
| Mensaje | string Example: Mensaje=Html content that is going to be sent Message that will be sent to the recipient(s), it is optional, you can send the message here or choose to use the Template parameter to send the corresponding template. The variables within the template must be of the type ###Variabel### which will then be personalized per recipient. There are reserved variables that can be used directly in the HTML and that will be updated with the corresponding values, these are:
###email### : It will be changed for the recipient's email
###destinatario###: Name of the recipient
###__fechahora__###: Date/Time of the sending (CET)
###__fecha__###: Date of the sending
###__hora__###: Time of the sending
###url_ver_en_web###: It will be modified for the link to the version viewed on web, example: 'if you do not see this email correctly click here'. Attention, the HideInWebView class is a class that allows, in our system, that once it appears in the web version, that content disappears. It is usually used so that, once it is in the web version, that message does not appear again, avoiding misunderstandings.
###url_unsubscribe###: It is the unsubscribe Url if you want us to manage it from the system, it will be added to your unsubscribe list.
SPECIAL FUNCTION: If you want an element (div, span, p,...) not to appear in the web view (when clicking view on web), you must add the hiddeninwebsite class to that element class="hiddeninwebsite"
|
| Fecha | string Example: Fecha=2022-05-01 15:10 Date on which the sending is scheduled, the message will be sent on that date. By default "" which means send immediately. Format Year-Month-day hour:minute. The time reference is CET/CEST (Time zone of Spain).
|
| Intervaloprohibido | Array of arrays Example: Intervaloprohibido=[{"HoraInicio":"22:00","HoraFin":"9:00","Accion":"1"}] JSON array with the start and end hours of the forbidden sending interval.
For example:
{
"HoraInicio": "22:00",
"HoraFin": "8:00"
},
|
| Adjuntos | Array of arrays JSON array with the attachments if you want to include them in the message.
For example:
[
{
"Nombre": "documento.pdf",
"Contenido": "JVBERi0xLjcNJeLjz9MNCjg0IDAgb2JqDTw...."
},
{
"Nombre": "otrodocumento.docx",
"Contenido": "IyBleHBvcnRlZCBmcm9tIGJhY2ts....."
}
]
|
| Seguimientoaperturas | integer Example: Seguimientoaperturas=1 If activated (1, by default) the openings of the sent emails will be tracked, if deactivated (0) no tracking will be done and you will not receive the opening reports in the report reception in your script.
|
| Seguimientoclicks | integer Example: Seguimientoclicks=1 If activated (1, by default) the clicks in the sent emails will be tracked, if deactivated (0) no tracking will be done and you will not receive the click reports in the report reception in your script.
|
| Listunsubscribe | string Example: Listunsubscribe=<mailto:listrequest@dominio.com?subject=unsubscribe>, <https://dominio.com/unsubscribe/identific1234567> If you send through CSA certified IPs it is mandatory to use this option or listHelp. It is a header supported by the main email managers that allows recipients to unsubscribe with one click. If you want unsubscribes to be managed automatically, leave this parameter and ListHelp blank
|
| Listhelp | string Example: Listhelp=<https://www.dominio.com/landing/listhelp>, <mailto:list-info@cominio.com> If you send through CSA certified IPs it is mandatory to use this option or listUnsubscribe. It is a header supported by the main email managers that allows indicating a landing where the recipient can find out the reason for receiving this email and, if they cannot unsubscribe (for example because they are OTP or transactional/operational messages, the reasons for receiving them.
|
| Referenciausuario | string Example: Referenciausuario=Your reference Parameter used as a reference for the whole campaign for the user. If you select to receive the report at a URL, you will receive this parameter in the result of the send and also the reference of each of the recipients if you indicated it in the user array.
|
| Report | integer Example: Report=0 If you want to receive reports in a script on your website (by activating the API configuration in the user panel).
|
| Resp | string Enum: "TXT" "JSON" "XML" Example: Resp=JSON Type of response to return as the result of the call.
ANT - (Obsolete). Kept for compatibility with previous versions
JSON - The response will be returned in JSON
XML - The response will be returned in XML
TXT - The response will be returned in Text format
|