REST API: Add Space Role

Vivek Thakur

Published: 3/29/2011

Grace Kamau

Updated: 8/27/2020

0 (0votes)

Add space role

Adds a new role to the space. Valid for Communifire version 5.2 and above.

HTTP Method

POST

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.
Role JSON	Used in the request body	This is JSON that represents a role object that you're creating. This should be of the format seen below in the sample given. The required values in this JSON are given below.
Description	Used in the request body	Description of the role.
RoleName	Used in the request body	Name of the role.
SpaceID	Used in the request URL	Unique identifier for a particular space.

Example URL to POST: https://your-community.com/api/spaces/12/roles


{
    "Description":"A person who's job is to tests something, especially a new product.",
    "RoleName": "Tester",
}


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

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