//[[restapi:start|RESTful API]]//

====== Send Email ======

==== Overview ====

Send a email message

==== URL ====

Parameters on the following URL are inside braces { }

  {base_url}/rest/api/tools/sendEmail/{instanceId}/{from}/{to}/{subject}/{publicKey}/{signature}
  
<WRAP round tip>
Please note that on the URL you won't see any POST parameters, only the regular parameters \\ All POST parameters will be <wrap notice>highlighted</wrap> in the following table.
</WRAP>

^ Parameter Name ^ Description ^
| instanceId | An **instance id** is the workspace identification number, //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| from | The sending email's address. This parameter must be [[restapi:appx_ciphering|Base64 encoded]]. |
| to | Recipient's email address. This parameter must be [[restapi:appx_ciphering|Base64 encoded]]. |
| subject | The email's subject. This parameter must be [[restapi:appx_ciphering|Base64 encoded]]. | 
| content \\ <wrap notice>POST</wrap> | A file that contains the content for your email message. This is a text file that could contain HTML format |
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|Java Example]] |
==== Response ====

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<input>sendEmail</input>
<status>OK</status>
<description>Completed</description>
<result>
	<blast>
		<blastId>-2490820026197535447</blastId>
		<status>FINISHED</status>
		<type>EMAIL</type>
		<statusDescription>Sending to the recipient</statusDescription>
		<clientId>As223sdadq8d8287v5v</clientId>
		<timezone>America/Caracas</timezone>
		<initialDate>2014-11-27T15:43:58.692-04:30</initialDate>
		<endDate>2014-11-27T15:43:58.723-04:30</endDate>
		<messages>
			<message>
				<blastId>-2490820026197535447</blastId>
				<id>2758ebc5-1db5-4822-a5ed-36121e0674a6</id>
				<type>PUSH</type>
				<from>Inbox</from>
				<to>13056708084</to>
				<subject>Inbox Push Ogangi</subject>
				<text>Inbox Push Ogangi Message</text>
				<status>SENT</status>
				<statusDescription>Sent</statusDescription>
				<date>2014-01-24T12:45:50.903-04:30</date>
				<timezone>America/Caracas</timezone>
			</message>
		</messages>
	</blast>
</result>

</code>

== Result parameters ==

<WRAP round tip>Please be aware that the **//<message>//** tag and its content is a generic object and may apply to other responses in other methods.</WRAP>

^ Parameter Name ^ Description ^ Possible Values ^
| blastId | The unique blast identification, a blast is always needed to send one or more messages | Text |
| status | Indicates current the blast's status | For more information please review the [[restapi:appx_msg_status#blast|Message's Status]] page |
| type | The blast's type | EMAIL |
| statusDescription | A human readable explanation about the blast's status | Text |
| clientId | The client identification (sender) | Text |
| timezone | Timezone used for this blast | Text |
| initialDate | Time mark at the origination moment | A formatted date string: **yyyy-MM-dd'T'HH:mm:ss.SSSZZ** \\ For more information please review the [[restapi:appx_date|pattern letters]] quick reference |
| endDate | Time mark at the culmination moment | A formatted date string: **yyyy-MM-dd'T'HH:mm:ss.SSSZZ** \\ For more information please review the [[restapi:appx_date|pattern letters]] quick reference | 
| message.blastId | Unique identifier for the blast used to fire the message | Text |
| message.id | Unique identifier for the message created | Text |
| message.type | Indicates the kind of message that was sent | **PUSH \\ SMS \\ EMAIL ** |
| message.from | Who sent the message | for PUSH, Application that sent the message \\ for SMS, Short/Long code which originated the message \\ for EMAIL, the email address which sent the message. |
| message.to | Recipient for this message | Any of the following: ** \\ deviceId \\ mobile number \\ email address ** |
| message.subject | Message's subject | Text |
| message.text | Message's content | Text |
| message.status | Indicates the message's status at the origination moment | See our [[restapi:appx_msg_status#blast|Message's Status]] page |
| message.statusDescription | A human readable explanation about the current status | Text |
| message.date | Time mark at the origination moment | A formatted date string: **yyyy-MM-dd'T'HH:mm:ss.SSSZZ** \\ For more information please review the [[restapi:appx_date|pattern letters]] quick reference |
| message.timezone | Timezone used | Text |

====== Email Blast by File ======

==== Overview ====

Send Email massively using as recipient a list of mobile numbers.

<WRAP round info>
The recipient list its a File (text or excel). Please read the [[restapi:appx_phonelist#email_recipient_list|Email Recipient List]] to learn more about this.
</WRAP>
==== URL ====

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/tools/sendEmailByFile/{instanceId}/{from}/{subject}/{publicKey}/{signature}
  
<WRAP round tip>
Please note that on the URL you won't see any POST parameters, only the regular parameters \\ All POST parameters will be <wrap notice>highlighted</wrap> in the following table.
</WRAP>

^ Parameter Name ^ Description ^
| instanceId | An **instance id** is the workspace identification number, //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| from | The sending email's address. This parameter must be [[restapi:appx_ciphering|Base64 encoded]]. |
| subject | The email's subject. This parameter must be [[restapi:appx_ciphering|Base64 encoded]]. | 
| to \\ <wrap notice>POST</wrap> | Recipients who will receive the message. Please read the [[restapi:appx_phonelist#email_recipient_list|Email Recipient List]] for more information about the recipient's file |
| content \\ <wrap notice>POST</wrap> | A file that contains the content for your email message. This is a text file that could contain HTML format |
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|Java Example]] |
==== Response ====

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<input>sendEmailByFile</input>
<status>OK</status>
<description>Completed</description>
<result>
	<blast>
		<blastId>-2490820026197535447</blastId>
		<status>FINISHED</status>
		<type>EMAIL</type>
		<statusDescription>Sending to the recipient</statusDescription>
		<clientId>As223sdadq8d8287v5v</clientId>
		<timezone>America/Caracas</timezone>
		<initialDate>2014-11-27T15:43:58.692-04:30</initialDate>
		<endDate>2014-11-27T15:43:58.723-04:30</endDate>
		<messages>
			<message>
				<blastId>-2490820026197535447</blastId>
				<id>2758ebc5-1db5-4822-a5ed-36121e0674a6</id>
				<type>PUSH</type>
				<from>Inbox</from>
				<to>13056708084</to>
				<subject>Inbox Push Ogangi</subject>
				<text>Inbox Push Ogangi Message</text>
				<status>SENT</status>
				<statusDescription>Sent</statusDescription>
				<date>2014-01-24T12:45:50.903-04:30</date>
				<timezone>America/Caracas</timezone>
			</message>

			...

			<message>
				<blastId>-564646154894654545</blastId>
				<id>489cf77-4fbc-4822-a5ed-21516555fd1e</id>
				<type>PUSH</type>
				<from>testApp</from>
				<to>18133210984</to>
				<subject>testApp Push Ogangi</subject>
				<text>testApp Push Ogangi Message</text>
				<status>SENDING</status>
				<statusDescription> Sending to device </statusDescription>
				<date>2014-01-24T12:45:50.903-04:35</date>
				<timezone>America/Caracas</timezone>
			</message>
		</messages>
	</blast>
</result>

</code>

== Result parameters ==

<WRAP round tip>Please be aware that the **//<message>//** tag and its content is a generic object and may apply to other responses in other methods.</WRAP>

^ Parameter Name ^ Description ^ Possible Values ^
| blastId | The unique blast identification, a blast is always needed to send one or more messages | Text |
| status | Indicates current the blast's status | For more information please review the [[restapi:appx_msg_status#blast|Message's Status]] page |
| type | The blast's type | EMAIL |
| statusDescription | A human readable explanation about the blast's status | Text |
| clientId | The client identification (sender) | Text |
| timezone | Timezone used for this blast | Text |
| initialDate | Time mark at the origination moment | A formatted date string: **yyyy-MM-dd'T'HH:mm:ss.SSSZZ** \\ For more information please review the [[restapi:appx_date|pattern letters]] quick reference |
| endDate | Time mark at the culmination moment | A formatted date string: **yyyy-MM-dd'T'HH:mm:ss.SSSZZ** \\ For more information please review the [[restapi:appx_date|pattern letters]] quick reference | 
| message.blastId | Unique identifier for the blast used to fire the message | Text |
| message.id | Unique identifier for the message created | Text |
| message.type | Indicates the kind of message that was sent | **PUSH \\ SMS \\ EMAIL ** |
| message.from | Who sent the message | for PUSH, Application that sent the message \\ for SMS, Short/Long code which originated the message \\ for EMAIL, the email address which sent the message. |
| message.to | Recipient for this message | Any of the following: ** \\ deviceId \\ mobile number \\ email address ** |
| message.subject | Message's subject | Text |
| message.text | Message's content | Text |
| message.status | Indicates the message's status at the origination moment | See our [[restapi:appx_msg_status#blast|Message's Status]] page |
| message.statusDescription | A human readable explanation about the current status | Text |
| message.date | Time mark at the origination moment | A formatted date string: **yyyy-MM-dd'T'HH:mm:ss.SSSZZ** \\ For more information please review the [[restapi:appx_date|pattern letters]] quick reference |
| message.timezone | Timezone used | Text |

====== Email Blast by List ======

==== Overview ====

Send Email massively using as recipient a list of email addresses previously created on a workspace.

<WRAP round info>
The recipient is a List previously created trough GUI or Restful method [[restapi:create_segmented_distribution_list_custom_key_3_35|Create Segmentation List]]. 

This method requires the list's email column to have the name "email".
</WRAP>

==== URL ====

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/sendEmailByList/{instanceId}/{emailListId}/{userName}/{subject}/{date}/{hour}/{publicKey}/{signature}
  
<WRAP round tip>
Please note that on the URL you won't see any POST parameters, only the regular parameters \\ All POST parameters will be <wrap notice>highlighted</wrap> in the following table.
</WRAP>

^ Parameter Name ^ Description ^
| instanceId | An **instance id** is the workspace identification number, //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| emailListId | Target email list |
| userName | Name of the user who creates the email Blast. This parameter must be Base64 encoded |
| subject | The email's subject. This parameter must be [[restapi:appx_ciphering|Base64 encoded]]. | 
| date \\ <wrap notice>OPTIONAL</wrap> | The start date to use. \\ <wrap info>A formatted date string: **dd-MM-yyyy** For more information please review the [[restapi:appx_date|pattern letters]] quick reference </wrap> \\ <wrap info>Use **null** to ignore this parameter</wrap>  |
| hour \\ <wrap notice>OPTIONAL</wrap> | The desired hour to start the broadcast. \\ <wrap info>A formatted date string: **HH:mm** For more information please review the [[restapi:appx_date|pattern letters]] quick reference </wrap> \\ <wrap info>Use **null** to ignore this parameter</wrap> |
| content \\ <wrap notice>POST</wrap> | A file that contains the content for your email message. This is a text file that could contain HTML format |
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|Java Example]] |
==== Response ====

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<input>sendEmailByList</input>
<status>OK</status>
<description>Completed</description>
</code>

====== Email Blast by List With Custom Key ======

==== Overview ====

Send Email massively using as recipient a list of email addresses previously created on a workspace, indicating the name of the column including the email addresses.

<WRAP round info>
The recipient is a List previously created trough GUI or Restful method [[restapi:create_segmented_distribution_list_custom_key_3_35|Create Segmentation List]].
</WRAP>
==== URL ====

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/tools/sendEmailByList/{instanceId}/{emailListId}/{emailParameter}/{userName}/{subject}/{date}/{hour}/{publicKey}/{signature}
  
<WRAP round tip>
Please note that on the URL you won't see any POST parameters, only the regular parameters \\ All POST parameters will be <wrap notice>highlighted</wrap> in the following table.
</WRAP>

^ Parameter Name ^ Description ^
| instanceId | An **instance id** is the workspace identification number, //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| emailListId | Identification number for the list with the email recipients. (Previously created) |
| emailParameter | Parameter with the column's name on the list where the email address is present. This parameter must be [[restapi:appx_ciphering|Base64 encoded]].| 
| from | The sending email's address. This parameter must be [[restapi:appx_ciphering|Base64 encoded]]. |
| subject | The email's subject. This parameter must be [[restapi:appx_ciphering|Base64 encoded]]. | 
| content \\ <wrap notice>POST</wrap> | A file that contains the content for your email message. This is a text file that could contain HTML format |
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|Java Example]] |
==== Response ====

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<input>sendEmailByList</input>
<status>OK</status>
<description>Broadcast with ID: 21</description>
</result>
</code>

=== Result parameters ===

^ Parameter Name ^ Description ^ Possible Values ^
| status | Indicates current the blast's status | For more information please review the [[restapi:appx_msg_status#blast|Message's Status]] page |
| description | The unique blast identification, a blast is always needed to send one or more messages | Text |


====== Email Blast by List With From Field ======

==== Overview ====

Send Email massively using as recipient a list of email addresses previously created on a workspace, .

<WRAP round info>
The recipient is a List previously created trough GUI or Restful method [[restapi:dlist#create_segmented_distribution_list_with_custom_key|Create Segmentation List]].
</WRAP>

==== URL ====

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/sendEmailByListWithFromField/{instanceId}/{emailListId}/{userName}/{subject}/{date}/{hour}/{from}/{publicKey}/{signature}
  
<WRAP round tip>
Please note that on the URL you won't see any POST parameters, only the regular parameters \\ All POST parameters will be <wrap notice>highlighted</wrap> in the following table.
</WRAP>

^ Parameter Name ^ Description ^
| instanceId | An **instance id** is the workspace identification number, //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| emailListId | Target email list |
| userName | Name of the user who creates the email Blast. This parameter must be Base64 encoded |
| subject | The email's subject. This parameter must be [[restapi:appx_ciphering|Base64 encoded]]. | 
| date \\ <wrap notice>OPTIONAL</wrap> | The start date to use. \\ <wrap info>A formatted date string: **dd-MM-yyyy** For more information please review the [[restapi:appx_date|pattern letters]] quick reference </wrap> \\ <wrap info>Use **null** to ignore this parameter</wrap>  |
| hour \\ <wrap notice>OPTIONAL</wrap> | The desired hour to start the broadcast. \\ <wrap info>A formatted date string: **HH:mm** For more information please review the [[restapi:appx_date|pattern letters]] quick reference </wrap> \\ <wrap info>Use **null** to ignore this parameter</wrap> |
| from | This parameter must have description and the email address to be used as sender. Example: Description X <<<email@address.com>>> This will be displayed in the From field. This parameter must be [[restapi:appx_ciphering|Base64 encoded]]. \\ <wrap info>The email address to be used as sender must be verified in advance</wrap> | 
| content \\ <wrap notice>POST</wrap> | A file that contains the content for your email message. This is a text file that could contain HTML format |
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|Java Example]] |
==== Response ====

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<input>sendEmailByListWithFromField</input>
<status>OK</status>
<description>>>Broadcast with ID:3096</description>
</code>