Loading ...

REST API: Delete Space Role | Communifire Documentation

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

REST API: Delete Space Role

0 
 /5
0 (0votes)

Delete space role

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

Deletes the existing space role specified by Role ID. Returns JSON indicating whether or not the specified role was actually deleted. Valid for Communifire version 5.2 and above.

Method Details

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.
SpaceID Used in the request URL (see below) Unique identifier for a particular space.
RoleID Used in the request URL (see below) Unique identifier for a particular role.

Example URL to DELETE: https://your-community.com/api/spaces/3/roles/34

Response JSON sample where indicator (true/false) json object 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