Table of Contents

RESTful API

Create Segmented Distribution List

Overview

Creates a new distribution list with segmentation capabilities

This is a POST method, which means that you need to use it through a POST call

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/createSegmentedDistList/{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 ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
name Name of the distribution list. This parameter must be Base64 encoded
userName User name who creates the distribution list
file
POST 		Recipients who will receive the message. Please read the 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 ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our 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 Response XML Basics section if you want to learn more about the response parts. 

   <input>createSegmentedDistList</input>
   <status>OK</status>
   <description>Completed</description>
   <result>
      <distributionlist>
         <id>1</id>
         <name>Segmented List 1</name>
      </distributionlist>
   </result>
Result parameters
Parameter Name Description Possible Values
distributionlist.id Segmented Distribution list ID Number
distributionlist.name Segmented Distribution list name Text