4.18j

TextMarks API V2 - AutoDoc: RegisteredUser / opt_out()

Method: opt_out() (POST) - Opt out auth_user from all TextMarks communications

Package: RegisteredUser - Manage authenticated user's account/profile (... View package)

Args:

Req? Name Type Description Test
REQ auth_user User User account / phone# used for login
REQ auth_pass Password Password
OPT api_key API Key API Key (Register here)

Test:


Docs:

  • This is equivalent to texting STOP to 41411.
  • If the user has already opted out, receive error #2042 (ERR_REQUEST_ALREADY_DONE).

Resp:

JSON response.head.rescode==0 for success, or error code otherwise.
JSON-P callback: (as 'jsonp' param, optional) (blank for none)

HTTP:

POST http://help.api2.textmarks.com//RegisteredUser/opt_out/

More:

This page documents a single API function opt_out() within the RegisteredUser package of the TextMarks Text Message API.
You may use the interactive form above to invoke this function and observe its actual JSON response.

More resources: