Loading ...

REST API: Update Space Role | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Spaces » REST API: Space Roles » REST API: Update Space Role
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 14

REST API: Update Space Role

0 
 /5
0 (0votes)

Update space role

PUT /api/spaces/{spaceid}/roles/{roleid}

Updates an existing space role with Role ID with the properties as specified by JSON in the request body. 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 (see above) 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 request body Name of the role.
Description Used in the request body Description of the role.

Example URL to PUT: https://your-community.com/api/spaces/23/roles/780

Request JSON sample for updating a role - Stringify your JSON data


"{
    \"RoleName\":\"System Analyst\",
    \"Description\":\"A systems analyst uses computers and related systems to design new IT solutions, modify, enhance or adapt existing systems and integrate new features.\"
}"

Response JSON sample where indicator (true/false) is returned as ResponseData


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


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

Wiki Index

Pages

Intranet Software