TextMarks API V2 Documentation: GroupLeader.copy

Method: copy_members() (POST) - Copy group members from another group

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

Args:

Req?	Name	Type	Description

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	tm_from	TextMark	Source group to copy members from

OPT	api_key	API Key	API Key (Register here)
OPT	welcome	Bool (0/1)	Welcome users to new group? (default no)

Test:

Human? GET in new window?

Docs:

This method copies all members of the specified tm_from group to the tm group.
Both source and destination group must be owned by auth_user and belong to the same program.
If welcome is specified, then the members receive standard SMS welcome messages as if they had just opted in to the new group. Otherwise the action is silent.
Restrictions:
- The source and destination groups must be for similar purposes. E.g. if a user opted in for a promotion to win specific concert tickets, you may copy them to another group related to concert tickets in their region, but you would not be allowed to copy them to a group related to discount pet supplies.
Users who are already in the both groups are not affected.
If the destination group is not joinable, receive error #2034 (ERR_REQUEST_NOT_JOINABLE).
If the destination group is not associated with the same program, receive error #2017 (ERR_REQUEST_INVALID_PROGRAM).

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//GroupLeader/copy_members/

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

API Overview
API Error / Result Code reference
Client Libraries
Help / FAQ / File a ticket
Developer Support Hotline: (800) 696-1393

TextMarks API V2 - AutoDoc: GroupLeader / copy_members()