4.18h

TextMarks API V2 - AutoDoc: GroupLeader / members()

Method: members() (GET) - List users who have joined a TextMark 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
OPT api_key API Key API Key (Register here)
OPT since Timestamp Get only subscribers opted in after this time
OPT offset Integer 0-based result to start with (default 0)
OPT count Integer #results desired (max 100) (default 20)
OPT params CSL TextMark User Data params to load
OPT pmeta Bool (0/1) Load Program User Data params too?

Test:


Docs:

  • Load group members (subscribers), optionally filtering by only those who subscribed recently (since since).
  • Response includes total # matching subscribers even when paginating.
  • Optionally specify params to load named TextMark/User data params.
    • Internal param names begin with "_", e.g. "_custom1" (custom field saved by sub widget).
    • If more than 100000 matching param definitions are found, receive error #2024 (ERR_REQUEST_TOO_MANY_RESULTS).
  • Optionally specify pmeta to load named all non-internal Program/User data params (user metadata).
    • If more than 100000 matching param definitions are found, receive error #2024 (ERR_REQUEST_TOO_MANY_RESULTS).

Resp:

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

HTTP:

GET https://api2ssl.textmarks.com//GroupLeader/members/

More:

This page documents a single API function members() 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: