REST API: Check Space Name Availability

Vivek Thakur

Published: 3/29/2011

Grace Kamau

Updated: 7/8/2021

0 (0votes)

Check space name availability

Check if the desired space name is available or not. Valid for Communifire version 5.2 and above.

HTTP Method

GET

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.
SpaceName	?spacename=x - Used in the request URL (see below)	Desired space name.

Example URL to GET: http://your-community.com/api/spaces/availability?spacename=Customers


{
    "IsError":false,
    "ResponseMessage":"Customers",
    "ResponseData":"True"
}

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