API REFERENCE GUIDE

USER SUBSCRIPTION  unsubscribe

api description

purpose

unsubscribe starts an unscription process by sending to subscriber a customizable email which contains a confirmation link in order to perform the unsubscription.

unsubscribe requires valid session parameters: uuid, usid, udid and eost. See signin for further details.

http method: POST

call cost: 1 point

See the pricing section for more details.

mandatory parameter(s)

parameter values / comments
api"unsubscribe"
key E.g. "c54e7837e0cd0ced286cb5995327d1ab54e35987179b2". It is an application key generated by AuverCloud Studio.
uuidUnique User ID.
usidUnique Session ID.
udidUnique Device ID.
eostEnd of Session Time.
subjectUnsubscription email subject e.g. "Please confirm your unsubscription from XYZ."
contentUnsubscription email HTML content e.g. "To confirm your unsubscription from XYZ, please click the following <a href='%link%'>link</a>. After this step all your data will be deleted."

PLEASE NOTE: In the example below the following keyword is important!

  • %link% will be replaced by a link dynamically computed by the API. See also callback in the optional parameters.

optional parameters(s)

parameter values / comments
callbackThis is the callback URL for the confirmation. The default value is the API server "".

We suggest you to replace this default address with a customized one in order to provide the end user with some personalized feedback. In that case, your customized address must intercept the parameters and then forward them to the API server in a transparent way.

For instance, if you choose the callback address http://xyz.com, the confirmation link would look like http://xyz.com?any_parameter=any_value. Whatever the page http://xyz.com does, it must forward the parameters to the standard API server to finalize the process, here ?any_parameter=any_value.

ttl This defines the confirmation link time-to-live before being disabled. The default value is one "hour". Other possible values are "day" or "week".

call sample

This example is the code used in the test case below. It assumes that jQuery and the JavaScript AuverCloud runtime client are loaded in order to use the arc.api() method. See the API client section for more details.


							

errors

code message comments
609 Forbidden parameter value. ttl value is wrong.

See also the Common errors section.

test bed

Call

To test the API with your own keys, please see the section Application keys in AuverCloud Studio.

api
unsubscribe
key
subject
content
callback
ttl
 send
request
 clear
response
Response
code
msg
data

discussion