Edit Group

From KickApps Documentation

Edit an existing group within your community. You can make an HTTP POST or GET request for this call. This call is only available to users with administrative access permissions for their token.

http://api.kickapps.com/rest/group/edit/{groupId}/{as}

Contents 1 Parameters 2 Post Parameters 3 JSON Payload 4 Permissions 5 Overview 6 Parameters 7 Post Parameters 8 JSON Payload 9 Permissions 10 List of KickApps API Calls

Parameters

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

• groupId. The ID of the group to be edited.
• 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".
• groupName. Optional. The new name for the group.
• category. Optional. The new category to which the group should be assigned.
• description. Optional. The group’s new description.

If included, the values for any of the group parameters listed above will overwrite the existing group metadata.

JSON Payload

On success, a payload that begins with "status":"1","error":"" and includes updated group object.

• status. 1 if the call was a success. -1 if the call produced an error.
• error. If the call status is -1, error will contain descriptive text for the error.

The group object will contain the following:

• isPublicTaggingAllowed. true or false. Whether or not community members can tag this group.
• groupCategories. categories assigned to the group.
• numMembers. Number of members that are assigned to the group. *adminTags. Admin Tags assigned to the group.
• name. Name of the group
• createdAtA nested object stating when the group was created. All times are returned as Greenwich Mean Time (GMT).

dayofweek, month day, time AM or PM

This would appear as follows:

"createdAt":"Wednesday, Jul 7, 07:48"

• description. The description of the group.
• createdBy. The id of the member/webmaster who created the group.
• isVisible. true or false. Whether the group is visible to the community members.
• numAudios. Number of Audios assigned to the group.
• groupId. The id for the group.
• updatedAt. A nested object stating when the group was last updated. All times are returned as Greenwich Mean Time (GMT).

dayofweek, month day, time AM or PM

This would appear as follows:

"updatedAt":"Wednesday, Jul 7, 07:48",

• numComments. Number of comments left for the group.
• pathToPreview The url for the group icon.
• mediaType. Media type for groups is "CLUB".
• pathToPhoto. The url for the group icon.
• numPhotos. Number of photos assigned to the group.
• numBlogs. Number of blogs assigned ot the group.
• numVideos. Number of videos assigned to the group.
• updateBy. Member Id for the member who last updated the group.
• tags. tags assigned to the group.
• mediaId. The id for the group. Same as groupId.

Permissions

Overview

KickConnect 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 KickApps API Calls

API Change Log Create Token Call Social Networking Retrieve Member Profile Add Or Remove Member As Friend Get A Member's Friends, Fans, and "Fan Of" Retrieve User by Facebook Id KickConnect Assign Member Profile Photo Remove Member Profile Photo Member Profile Edit/Update SSO Method Member Register SSO Method Combined Member Sign On and Register SSO Method Member Change Username SSO Method Member Change Email SSO Method OpenAuth Create Message Board Media Sharing Upload Media Retrieve Media Meta Data Edit Media Meta Data Delete Member Media Retrieve Play Page Retrieve Member Media Retrieve Member's Favorite Media Retrieve Related Media Member Favorite Media Check Email Media Add Or Remove Media Flag Add To Or Remove From Favorites Geographic Values for Media Uploads Get Video Thumbnails Set Video Thumbnail Blogging Add Blog Post Edit Blog Post Comments and Rating Add External Media Retrieve External Media Edit External Media Add Group Comment Add Media Comment Add Profile Comment Retrieve Comments Search Comments Edit Comment Edit Group Comment Delete Comment Delete Group Comment Flag Comment Flag Group Comment Rate Media Retrieve Media Ratings Retrieve Media Rated By Member Retrieve Likes By User ID Search Search Media Sets Add Media Set Edit Set Retrieve Set Delete Set Add Media to Set Remove Media from Set Groups Add Group Retrieve Group Page Edit Group Request A Group Add/Remove Media To Group Add/Remove Member To Group Retrieve Member Groups Upload Group Photo Remove Group Photo Polls Creating Polls Using the Tag API’s

Badges Add Badge Edit Badge List Badges Add Action List Actions Add Badge Requirement Edit Badge Requirement List Badge Requirements Add User Action Retrieve User's Badges Retrieve User's Badge Status Retrieve Super Fans Get Super Fan Ranking Set Super Fan Badge Criteria Categories and Tags Add Tags To Media, Members and Groups Remove Tags From Media, Members and Groups Add Admin Tags To Media, Members and Groups Remove Admin Tags From Media, Members and Groups Retrieve Admin Tags Retrieve Tag Count Add Category Edit Category Retrieve Category Delete Category Add Custom Meta Data Remove Custom Meta Data Retrieve Custom Meta Data Member and Media Management Approve Member Reject Member Approve Member Media Reject Member Media Delete Member Media Retrieve Pending Media Retrieve Active Member Count Retrieve Site Settings CRM Connectors KickApps SugarCRM Connector KickApps Salesforce Connector CRM Connectors (COMING SOON!!) IBM Websphere Microsoft Dynamic CRM NetSuite Oracle CRM On Demand Oracle E-Business Suite CRM PeopleSoft Enterprise CRM Oracle Siebel CRM SAP CRM Sugar Professional Maximizer CRM Pegasystems Customer Process Manager

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.