Documentation

Add/Remove Member To Group

From KickApps Documentation

Jump to: navigation, search

Calls to add and remove existing members to existing groups. You can make an HTTP POST or GET request for this call. This call may only be invoked if the token identifies the session as belonging to the administrator or the member being added or removed. 

http://api.kickapps.com/rest/member/{memberId}/add/group/{groupId}/{as}
http://api.kickapps.com/rest/member/{memberId}/remove/group/{groupId}/{as}

Contents

Parameters

As shown above, your call will include the following parameters:

  • memberId. The ID of the member to be added or removed.
  • groupId. The ID of the group to be retrieved.
  • as. The site that the group is a part of. as is unique for each of the affiliate's sites.

Post Parameters

  • t. String. Required. Your access permissions.
  • callback. String. Optional. The name of your JavaScript callback function.
  • clientIP. String. Optional. Use the clientIP parameter to pass the IP address of the user making the call. If the IP has been blocked by the webmaster under the Affiliate Center -> Manage Members section, an error message will be returned starting with "status":"-1","error":"This IP address has been banned".

JSON Payload

On success, a payload that begins with "status":"1","error":"" and includes the updated member list.

  • pathToPhoto. The url to the members profile photo.
  • firstName. Group members first name.
  • lastName. Group members last name.
  • username. Group members username.
  • id. Group members id.

If the member is already a member of the group, the following payload will be returned: {"info":"user is already a member of this club","payload_type":"json","status":"-1","error":"unable to perform this operation"}

Permissions

Overview

KIT Cloud Social API call that lets you post activities done outside the community into the community activity feeds for members.

Your request will look something like the following: 

http://api.kickapps.com/rest/kickconnect/{memberId}/{as}

Parameters

As shown above, your call will include the following parameters:

  • memberId. The id of the user for who the update is being made.
  • as. The site Id to search. as is unique for each of the affiliate's sites.

Post Parameters

  • t. String. Required. Your access permissions.
  • callback. String. Optional. The name of your JavaScript callback function.
  • clientIP. String. Optional. Use the clientIP parameter to pass the IP address of the user making the call. If the IP has been blocked by the webmaster under the Affiliate Center -> Manage Members section, an error message will be returned starting with "status":"-1","error":"This IP address has been banned".
  • storyContent. Required. Accepts HTML and text. Allows 5,000 characters. Be sure to urlEncode the string that you pass for this variable.
  • storyIcon. Optional. url of the image to be associated with the story. Recommended size is 16 X 16.
  • postedFromSource. Optional. This is the name of the service from which the activity is being posted from. Allows 200 characters.
  • postToGroups. Optional. Should accept comma separated groupID's. Should only post to a group if the user is a member of that group.

JSON Payload

  • On success, the call will return "status":"1","message":"Story published successfully."
  • On failure, the call will return "status":"-1","message":"Story could not be published. Please make sure that the provided information is accurate."
  • If the user doesn't belong to the group(s) return, "status":"-1","message":"Story could not be published. Please make sure that the member belongs to the group(s)."

Permissions

List of Kit Cloud Social API Calls


Note: Occasionally (and without advanced warning) we modify our API calls by adding new parameters in the response payload. Please keep this in mind when designing your strategy for parsing our responses.

Retrieved from "http://www.kickapps.com/documentation/index.php/Add/Remove_Member_To_Group"