Whether a lowercase Community name is free. Names are globally unique at the AppView, and a record whose name is taken is rejected at projection time rather than at write time, so clients check before writing.
Parameters
Output
Encoding
application/jsonavailable
boolean
Required
No description available.
name
string
Required
No description available.
reason
string
Optional
Why the name is unavailable. Absent when available.
Known values:
taken, invalid, reservedTry It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "query",
"output": {
"schema": {
"type": "object",
"required": [
"name",
"available"
],
"properties": {
"name": {
"type": "string"
},
"reason": {
"type": "string",
"description": "Why the name is unavailable. Absent when available.",
"knownValues": [
"taken",
"invalid",
"reserved"
]
},
"available": {
"type": "boolean"
}
}
},
"encoding": "application/json"
},
"parameters": {
"type": "params",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 63,
"minLength": 2
}
}
},
"description": "Whether a lowercase Community name is free. Names are globally unique at the AppView, and a record whose name is taken is rejected at projection time rather than at write time, so clients check before writing."
}