Loading ...

REST API: Update Role | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: User Roles » REST API: Update Role
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 17

REST API: Update Role

0 
 /5
0 (0votes)

Please Note This method updates roles at the Top Level Community. See REST API: Update Space Role for how to update a space role via the REST API.

Update Role

PUT /api/roles/{RoleID}

Update a top level role. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
PUT
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.
RoleID Used in the request URL as a path parameter Unique identifier for a particular role.
Role JSON Used in the request body This is JSON that represents a role object that you're updating. This should be of the format seen below in the sample given.
Optional Parameters How to use Description
RoleName Used in the Role JSON request body Name of the role.
Description Used in the Role JSON request body Description of the role.

Example Request

PUT https://myintranet.communifire.com/api/roles/132

Body:

"{
    \"RoleName\":\"Quality Analyst\",
    \"Description\":\"A software quality analyst is responsible for applying the principles and practices of software quality assurance throughout the software development life cycle.\"
}"

Note: Stringify your JSON data.

Example Response

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.

Wiki Index

Pages

Intranet Software