REST API: Unassign Role

Vivek Thakur

Published: 3/25/2011

Jennifer Kirkland

Updated: 2/17/2023

0 (0votes)

Please Note

This method only removes user roles at the Top Level Community if the Role is applied Manually. If assignment is automated through Personas, any Persona actions will overrule manual assignment.
To remove a user's Space Role via the REST API, see REST API: Unassign Space Role

Unassign Role

Remove a user's top level role. Valid for Communifire version 5.2 and above.

HTTP Method

DELETE

Response Format

JSON

Requires Authentication?

YES

Product Version

5.2 and above

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.
UserID	Used in the request URL as a path parameter	Unique identifier for a particular user.
RoleID	Used in the request URL as a path parameter	Unique identifier for a particular role.

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.