REST API: Update User Status

Vladana Garic

Published: 11/10/2023

Maxwell Drain

Updated: 3/13/2024

0 (0votes)

Update User Status

Update the status of multiple users by user ID. Valid for Communifire version 8.0 and above.

HTTP Method

PUT

Response Format

JSON

Requires Authentication?

YES

Product Version

Required Parameters	How to use	Description
API key	Used in the request URL: &token=x OR Set in header: request.Headers.Add(Rest-Api-Key, x)	Communifire REST API key for the Communifire portal you are making the call for
Action	Used in the request URL	Specifies the action to be performed on the user: ban, unban, activate, deactivate
UserIDCSV or UsernameCSV	Used in the request URL as a path parameter	Unique identifier for a list of users

Optional Parameters	How to use	Description
Reason	Used in the request URL as a query parameter	Providing additional context of a user's ban or deactivation
ReassignOption	&ReassignOption=x - Used in the request URL as a query parameter	Allows the transfer of content to another user, or deleting the content with a user. Option values are: 1, 2, 3 1 = Assign content to anonymous 2 = Assign content to another user 3 = Delete content with user Note: Only integer values accepted.
ReplacementUsername	Used in the request URL as a query parameter	Username of the user to reassign the content to

True/false is returned as ResponseData.

{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":true
}

Please Note The content type that you pass in the header of your request should be application/json.