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

====== Update User On Restriction List ======

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

==== Overview ====

Update user information on a restriction list.

==== URL ====

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/tools/updateRestrictionList/{instanceId}/{userOld}/{userNew}/{reasonNew}/{messageType}/{typeList}/{source}/{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// |
| userOld | Recipient current contact information (Email, phone number or device id). This parameter must be [[restapi:appx_ciphering|Base64 encoded]]| 
| userNew | Recipient new Email, phone number or device id. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] |
| reasonNew \\ <wrap notice>OPTIONAL</wrap> | New reason to add a user to a restriction list. <wrap info>Valid values are: BOUNCED | COMPLAINED for email or UNREACHABLE for SMS, push or voice call. Use "null" if you do not want to use it.</wrap> | 
| messageType | Type of message. <wrap info>Valid Values are : SMS, EMAIL, PUSH or VOICE.</wrap> | 
| typeList | Type of restriction list. <wrap info>Valid Values are: WHITE or BLACK</wrap> | 
| source | If you want to consider multiples codes to block/allow the recipient. 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>updateRestrictionList</input>
<status>OK</status>
<description>Completed</description>
<result>
	<users>
         <id>0</id>
         <user>restriction@ogangi.com</user>
         <reason>COMPLAINED</reason>
      </users>
</result>

</code>

== Result parameters ==

^ Parameter Name ^ Description ^ Possible Values ^
| users.id | Unique identifier for the user in a restriction list | Number |
| users.user | User updated in restriction list | Text |
| users.reason | Reason to update user into restriction list | Text |