RESTful API

Update User On Restriction List by Id (Tag 34)

Overview

Update user information on a restriction list given its id on the list.

URL

Parameters on the following URL are inside braces { }

{base_url}/rest/api/tools/updateRestrictionListById/{instanceId}/{id}/{userNew}/{reasonNew}/{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
id Recipient's id on the list
userNew Recipient new Email, phone number or device id
reasonNew New reason to add a user to a restriction list. 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.
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>updateRestrictionListById</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Successful registration</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the recipient was updated successfully true
false
message A human readable explanation Text