Package: RegisteredUser - Manage authenticated user's account/profile (... All packages)
Users with TextMarks authentication credentials (user nick or phone# and password/PIN) can access this API package. Users may receive a password/PIN:
- by registering on the TextMarks website.
- via the
Anybody.register_user()
API method. - from any 3rd party TextMarks affiliate site (e.g. Reactee).
With authentication credentials, users will usually do one or more of the following:
- Create TextMarks and groups
(see
create_textmark()
) and then access theTextMarkManager
andGroupLeader
API packages. (Only registered users can do this) - Join groups to subscribe to their messages, participate in discussions, or interact with 3rd party applications. (Users can do most of this from their phone without registering)
- Access public data as available to everybody and as exposed by the
Anybody
API package.
Note that users don't ever need to register and may still enjoy many TextMarks/41411 features from their phone regardless.
GET Methods:
-
textmarks()(GET) - List TextMarks managed by auth_user
-
blocked_users()(GET) - List users blocked by auth_user
-
groups()(GET) - List groups auth_user is a member of
-
is_group_member()(GET) - Check if auth_user is a member of a specific group
-
api_keys()(GET) - List auth_user's API keys
-
sms_conversations()(GET) - Load SMS conversation data related to auth_user's TextMarks
-
metadata()(GET) - Return metadata about auth_user.
POST Methods:
-
login()(POST) - Attempt to authenticate user/password
-
logout()(POST) - Log out authenticated user, clearing any session data
-
opt_out()(POST) - Opt out auth_user from all TextMarks communications
-
update()(POST) - Update auth_user account data (nick, email, password, etc.)
-
create_textmark()(POST) - Register a new TextMark keyword
-
block_user()(POST) - Block a user from messaging auth_user & his TextMarks
-
unblock_user()(POST) - Allow a blocked user to message auth_user & his TextMarks
-
join_group()(POST) - Join (subscribe to) a TextMark group
-
leave_group()(POST) - Leave (unsubscribe from) a TextMark group
-
post_group_message()(POST) - Post a message to a TextMark group
-
register_api_key()(POST) - Create an API key associated with a particular website for auth_user