4.18h

TextMarks API V2 - AutoDoc: GroupLeader / kick_member()

Method: kick_member() (POST) - Kick a user out of the group

Package: GroupLeader - Broadcast and manage messages and members (... View package)

Args:

Req? Name Type Description Test
REQ auth_user User User account / phone# used for login
REQ auth_pass Password Password
REQ tm TextMark TextMark group led by auth_user
REQ user User User account / phone# to kick (must be member of tm)
OPT api_key API Key API Key (Register here)

Test:


Docs:

  • This method forcibly removes a group member, as if the user had unsubscribed from the group themself.
  • No SMS confirmation is sent to the user.
  • If the user is not a member of the group, receive error #2035 (ERR_REQUEST_NOT_GROUP_MEMBER).

Resp:

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

HTTP:

POST https://api2ssl.textmarks.com//GroupLeader/kick_member/

More:

This page documents a single API function kick_member() within the GroupLeader 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: