Module: system
Method: remove-user-avatar
Deletes user avatar
Parameters:
- user_id - user ID (optional, authenticated user account used if not specified)
Method: statistic
Retrieves community stats
Parameters:
Method: remove-user
Deletes single user
Parameters:
- user_id - user ID (optional, authenticated user account used if not specified)
- reassign - reassign user generated data to anonymous user (mandatory, 0 or 1)
Method: switch-user-status
Switches user account status (active (enable) or banned (disable))
Parameters:
- user_id - user ID (optional, authenticated user account used if not specified)
- status - mandatory, accepts values «enable» or «disable»
Method: change-user-password
Alters user account password
Parameters:
- user_id - user ID (optional, authenticated user account used if not specified)
- current_password - current password (mandatory)
- new_password - new password (mandatory)
Method: users-list
Lists users registered in community. With optional filtering, paginated
Parameters:
- role - filter by user role (mandatory)
- sort - sorting direction (optional, creation date descending used by default). Accepted values: created_most, commented_most, top_rated
- page - page number (optional, first page if not specified)
Method: participants
Lists participants (author, official response authors, commenters) for single response
Parameters:
- response_id - response ID (mandatory)
Method: subscribers
Lists single response' subscribers
Parameters:
- response_id - response ID (mandatory)
Method: activity-list
Lists activity log entries, filterable by time range
Parameters:
- page - page number (optional, first page if not specified)
- date - filter by time range (optional, accepted values – today, yesterday, this_week, last_week, this_month, last_month)
Method: create-user
Creates new user account
Parameters:
- full_name - full name for new user (mandatory)
- email - email address for new user (mandatory)
Method: response-to-trash
Moves single response to trash
Parameters:
- response_id - response ID (mandatory)
Method: response-from-trash
Restores single response from trash
Parameters:
- response_id - response ID (mandatory)
Method: remove-response
Deletes single response, skipping trash
Parameters:
- response_id - response ID (mandatory)
Method: switch-response-status
Sets status for single response
Parameters:
- response_id - response ID (mandatory)
- status - response status to set (mandatory, accepted values could be retrieved via response-statuses API method call)
Method: subscribe
Subscribes currently authenticated user to response updates
Parameters:
- response_id - response ID (mandatory)
Method: unsubscribe
Unsubscribes currently authenticated user from response updates
Parameters:
- response_id - response ID (mandatory)
Method: lock-comments
Locks comments for single response
Parameters:
- response_id - response ID (mandatory)
Method: unlock-comments
Unlocks comments for single response
Parameters:
- response_id - response ID (mandatory)
Method: show-response
Retrieves single response and related data
Parameters:
- response_id - response ID (mandatory)
Method: response-types
Lists response types available
Parameters:
Method: response-statuses
Lists response statuses available, for single response type
Parameters:
- type - response type (mandatory, accepted values could be retrieved via «response-types» API method call)
Method: responses
Lists responses in community, filterable
Parameters:
- date - filter by time range(optional, accepted values: today, yesterday, this_week, last_week, this_month, last_month)
- type - filter by response type (optional, accepted values could be retrieved via «response-types» API method call)
- status - filter by response status (optional, values could be retrieved via “response-statuses” API method call). Also, 2 special status filter could be used: popular, new.
- text - filter by text in response title/body (optional)
- category - filter by category ID (optional)
Method: create-response
Creates new response
Parameters:
- type - response type (mandatory, accepted values could be retrieved via «response-types» API method call)
- title - title for new response (mandatory)
- content - body for new response (mandatory)
- tags - comma-separated tags list (optional)
Method: change-response
Alters single response
Parameters:
- response_id - response ID (mandatory)
- type - new type for response (optional, accepted values could be retrieved via «response-types» API method call)
- title - new title for response (optional)
- content - new body for response (optional)
- tags - comma-separated tags list for response (optional)
Method: create-answer
Creates official answer for single response
Parameters:
- response_id - response ID (mandatory)
- answer - official answer text (mandatory)
Method: change-answer
Alters existing official answer for single response
Parameters:
- response_id - response ID (mandatory)
- answer - official answer text (mandatory)
- notify - notify subscribers about official answer changed (optional, accepted values 0 or 1)
Method: vote-for-response
Casts vote for single response
Parameters:
- value - vote value (mandatory, accepted values: -1, 1)
- response_id - response ID (mandatory)
- comment - comment text to place along with vote (if use_negative_votes enabled for community)
Method: show-user
Retrieves details for single user account
Parameters:
- user_id - user ID (optional, authenticated user used if not specified)
Method: change-user
Alters single user name and/or email address
Parameters:
- user_id - user ID (optional, authenticated user used if not specified)
- full_name - full name of user (optional)
- email - email of user (optional)
Method: set-response-order
Overrides output order for single response (for homepage responses blocks)
Parameters:
- response_id - response ID (mandatory)
- order - position in responses list on home page. Accepted values: 0 – down, 1 – normal, 2 - top