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

====== Create Email List ======

==== Previous Versions ====
<wrap button>[[restapi:create_email_list_3_34|Tag 34]]</wrap>

==== Overview ====

Create an empty email list.

==== URL ====
Http access method: <wrap notice>POST</wrap>

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/emailList/{instanceId}/{name}/{userName}/{publicKey}/{signature}

^ 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// |
| name | Name of the email list. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] |
| userName | Name of the user who creates the email list. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] |
| 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>createEmailList</input>
<status>OK</status>
<description>Completed</description>
<result>
    <emaillist>
        <id>0101</id>
        <name>EmailListName</name>
    </emaillist>
</result>

</code>

== Result parameters ==

^ Parameter Name ^ Description ^ Possible Values ^
| emaillist.id | Email list ID | Number |
| emaillist.name | Email list name | Text |

====== Get Email List ======

==== Overview ====

Obtains Email List NAME and ID given the name or obtains all Email Lists in a workspace if name is <wrap notice>null</wrap>.

==== URL ====
Http access method: <wrap notice>GET</wrap>

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/emailList/{instanceId}/{name}/{publicKey}/{signature}

^ 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// |
| name | Name of the email list. This parameter must be [[restapi:appx_ciphering|Base64 encoded]]. \\ <wrap notice>OPTIONAL</wrap> \\ <wrap info>Use **null** to get all Lists present in this workspace</wrap> |
| 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>getEmailList</input>
<status>OK</status>
<description>Completed</description>
<result>
    <emaillist>
        <id>0101</id>
        <name>EmailListName</name>
    </emaillist>
</result>

</code>

== Result parameters ==

^ Parameter Name ^ Description ^ Possible Values ^
| emaillist.id | Email list ID | Number |
| emaillist.name | Email list name | Text |