social.colibri.beta.community.update
Updates a community's settings. A field left absent stays unchanged.
Details · procedure
| Kind | procedure |
|---|---|
| Authority | community.beta.colibri.social |
| Indexed |
Checks
Validunlimited-stringdefs.main.input.schema.properties.customEmojiNo maxLength, maxGraphemes or format limits this string.
{
"$type": "com.atproto.lexicon.schema",
"defs": {
"main": {
"description": "Updates a community's settings. A field left absent stays unchanged.",
"errors": [
{
"description": "The request is missing, malformed, or unverifiable service auth.",
"name": "AuthRequired"
},
{
"description": "The requesting user lacks the community.manage permission.",
"name": "Forbidden"
},
{
"description": "No community exists with that DID.",
"name": "CommunityNotFound"
},
{
"description": "The AppView's stored credentials for this community are missing or unusable.",
"name": "CredentialsUnavailable"
},
{
"description": "A PDS or third-party call the AppView depends on failed.",
"name": "UpstreamFailure"
}
],
"input": {
"encoding": "application/json",
"schema": {
"properties": {
"community": {
"description": "The community to update.",
"format": "did",
"type": "string"
},
"customEmoji": {
"description": "Which custom emoji render in this community. all allows custom emoji from any source, local only the community's own emoji, none disables custom emoji. Disallowed emoji show their fallback text.",
"knownValues": [
"all",
"local",
"none"
],
"type": "string"
},
"description": {
"description": "The community's description.",
"maxLength": 256,
"type": "string"
},
"hideOwnerBadge": {
"description": "Whether the owner badge next to the community owner's name is hidden.",
"type": "boolean"
},
"labelers": {
"description": "DIDs whose labels this community honours.",
"items": {
"description": "A labeler.",
"format": "did",
"type": "string"
},
"type": "array"
},
"linkEmbeds": {
"description": "Whether link previews are shown by default.",
"type": "boolean"
},
"name": {
"description": "The community's name.",
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"overrideUserNameColors": {
"description": "Whether only role colours are shown in chat. Members' own name colours are hidden, and a member without a coloured role shows the default name colour.",
"type": "boolean"
},
"requiresApprovalToJoin": {
"description": "Whether joining produces an application to approve.",
"type": "boolean"
}
},
"required": [
"community"
],
"type": "object"
}
},
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"community": {
"description": "The updated community.",
"ref": "social.colibri.beta.community.defs#communityView",
"type": "ref"
}
},
"required": [
"community"
],
"type": "object"
}
},
"type": "procedure"
}
},
"id": "social.colibri.beta.community.update",
"lexicon": 1
}