~~NOTOC~~

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

====== Edit Segmented Distribution List ======

==== Previous Versions ====
<wrap button>[[restapi:edit_segmented_distribution_list_3_35|Tag 35]]</wrap>

==== Overview ====

Method to add, edit or remove a user from a segmented distribution list. Please switch the call method to obtain the desired behavior as follows:

^ Call Method ^ Behavior ^
| HTTP GET | Retrieves a user information |
| HTTP DELETE | Removes a user from a segmented subscription list | 
| HTTP POST | Adds a new user to a segmented list | 
| HTTP PUT | Updates an existing user | 

==== URL ====

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/editSegmentedDistList/{instanceId}/{distListId}/{mobileNumber}/{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// |
| distListId | Distribution List ID |
| mobileNumber | User's mobile number |
| body \\ <wrap notice>POST %%|%% PUT</wrap> | This is a JSON string with pair-values in which must come the parameters to add or update for the given user. Ex. **{"name":"john","age":"56"}** |
| 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.

=== POST, PUT & DELETE ===

<file xml>
<response>
	<input>editSegmentedDistList</input>
	<status>OK</status>
	<description>Completed</description>
	<response>
		<code>S-0000</code>
		<description>User 123456789 has been deleted from list 4675</description>
	</response>
</response>
</file>

=== GET ===
<code xml>
<response>
   <input>getSegmentedDistList</input>
   <status>OK</status>
   <description>Completed</description>
   <result>
      <distributionlist>
         <id>1</id>
         <name>List Name</name>
         <parameters>
            <parameter>
               <key>customer_phone_num</key>
               <value>12000000002</value>
            </parameter>
                        
            ...
            
            <parameter>
               <key>Delivery Method</key>
               <value>SMS</value>
            </parameter>
         </parameters>
      </distributionlist>
   </result>
</response>
</code>

== Result parameters ==

^ Parameter Name ^ Description ^ Possible Values ^
| distributionlist.id | Distribution list ID | Number |
| distributionlist.name | Distribution list name | Text |
| distributionlist.parameters.parameters.key | Representa nombre del parámetro de la lista | Text |
| distributionlist.parameters.parameters.value | Represente el valor asociado al parámetro de la lista | Text |