====== Create Segmented Distribution List With Custom Key ======

==== Overview ====

Creates a new distribution list with segmentation capabilities with a custom key

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

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/segmentedDistList/{instanceId}/{name}/{userName}/{listKey}/{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 distribution list. Please read [[restapi:appx_phonelist#list_name|List Name]] section. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] |
| userName | User name who creates the distribution list. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] |
| listKey \\ <wrap notice>OPTIONAL</wrap> | Custom main parameter key of the list. This parameter must be present in the file header. \\ <wrap info>Use **null** to ignore this parameter</wrap>| 
| file \\ <wrap notice>POST</wrap> | Recipients who will receive the message. Please read the [[restapi:appx_phonelist#segmented_recipient_list|Segmented Recipient List]] for more information about this file |
| 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>createSegmentedDistList</input>
   <status>OK</status>
   <description>Completed</description>
   <result>
      <distributionlist>
         <id>1</id>
         <name>Segmented List 1</name>
      </distributionlist>
   </result>
</code>

== Result parameters ==

^ Parameter Name ^ Description ^ Possible Values ^
| distributionlist.id | Segmented Distribution list ID | Number |
| distributionlist.name | Segmented Distribution list name | Text |