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

====== Add to Restriction List (Bulk) ======

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

==== Overview ====

The API support a global restriction list, clients can block traffic to a desired recipient by adding it to the restriction list, you can load big user's list at once using this method.

<WRAP round tip>
We support both **white** restriction list and **black** restriction list. Keep in mind that the **whitelist** recipients are allowed and the **blacklist** recipients are not.

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

==== URL ====

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/tools/addToRestrictionListByFile/{instanceId}/{messageType}/{typeList}/{source}/{publicKey}/{signature}

<WRAP round tip>
Please note that on the URL you won't see any POST parameters, only the regular parameters \\ All POST parameters will be <wrap notice>highlighted</wrap> in the following table.
</WRAP>

^ 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// |
| 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_-_encode|Base64 encoded]] |
| file \\ <wrap notice>POST</wrap> | Recipients who will receive the message. Please read the [[restapi:appx_wb_list#restriction_list_file_format|restriction list file format]] for more information about this text 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>addUserToRestrictionListByFile</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult>
		<successful>true</successful>
		<message>Successful</message>
		<unsuccessful>
			<failedUser>jonhdoe@gmail.com</failedUser>
		</unsuccessful>
<transactionResult>
</result>

</code>

== Result parameters ==

^ Parameter Name ^ Description ^ Possible Values ^
| successful | Indicates if the recipients were added to the restriction list | <color blue>true</color> \\ <color red>false</color> |
| message | A human readable explanation | Text |
| unsuccessful | Recipients list that couldn't be added | Text |