Deletes an invitation code.
Input
Encoding
application/jsoncode
string
Required
The invitation code to delete.
community
stringdid
Required
The community the invitation belongs to.
Output
Encoding
application/jsonErrors
AuthRequired
The request is missing, malformed, or unverifiable service auth. Forbidden
The requesting user lacks the invitation.delete permission. CommunityNotFound
No community exists with that DID. InvitationNotFound
No invitation exists with that code. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "procedure",
"input": {
"schema": {
"type": "object",
"required": [
"community",
"code"
],
"properties": {
"code": {
"type": "string",
"description": "The invitation code to delete."
},
"community": {
"type": "string",
"format": "did",
"description": "The community the invitation belongs to."
}
}
},
"encoding": "application/json"
},
"errors": [
{
"name": "AuthRequired",
"description": "The request is missing, malformed, or unverifiable service auth."
},
{
"name": "Forbidden",
"description": "The requesting user lacks the invitation.delete permission."
},
{
"name": "CommunityNotFound",
"description": "No community exists with that DID."
},
{
"name": "InvitationNotFound",
"description": "No invitation exists with that code."
}
],
"output": {
"schema": {
"type": "object",
"required": [],
"properties": {}
},
"encoding": "application/json"
},
"description": "Deletes an invitation code."
}