Hides a Colibri member's message after a moderator removed its copy on the other service. The community applies a hidden label to the message. Works only when an admin has turned on moderation mirroring for the registration.
Input
application/jsonchannel
stringspace-ref
Required
The linked channel or thread the message lives in.
community
stringdid
Required
The community the registration belongs to.
reason
string
Optional
Human-readable reason.
maxLength: 512 bytesregistration
stringtid
Required
Record key of the registration.
subject
refsocial.colibri.beta.defs#recordRef
Required
The message to hide.
Output
application/jsonErrors
AuthRequired
The request is missing, malformed, or unverifiable service auth. CommunityNotFound
No community exists at the given DID. RegistrationNotFound
The community has no bridge registration with that id. Forbidden
The caller is not the bridge this registration belongs to. RegistrationDisabled
An admin has paused this registration. ChannelNotLinked
The channel is not linked to this registration. RateLimited
The bridge sent too many requests. Retry after the interval in the response headers. CredentialsUnavailable
The AppView cannot act as the community because its stored credentials are missing or unusable. ModerationMirrorOff
Moderation mirroring is turned off for this registration. RecordNotFound
No message exists at the given key in that channel. NotBridged
The message was written by the community itself. Delete it with deleteMessage instead. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "Hides a Colibri member's message after a moderator removed its copy on the other service. The community applies a hidden label to the message. Works only when an admin has turned on moderation mirroring for the registration.",
"errors": [
{
"description": "The request is missing, malformed, or unverifiable service auth.",
"name": "AuthRequired"
},
{
"description": "No community exists at the given DID.",
"name": "CommunityNotFound"
},
{
"description": "The community has no bridge registration with that id.",
"name": "RegistrationNotFound"
},
{
"description": "The caller is not the bridge this registration belongs to.",
"name": "Forbidden"
},
{
"description": "An admin has paused this registration.",
"name": "RegistrationDisabled"
},
{
"description": "The channel is not linked to this registration.",
"name": "ChannelNotLinked"
},
{
"description": "The bridge sent too many requests. Retry after the interval in the response headers.",
"name": "RateLimited"
},
{
"description": "The AppView cannot act as the community because its stored credentials are missing or unusable.",
"name": "CredentialsUnavailable"
},
{
"description": "Moderation mirroring is turned off for this registration.",
"name": "ModerationMirrorOff"
},
{
"description": "No message exists at the given key in that channel.",
"name": "RecordNotFound"
},
{
"description": "The message was written by the community itself. Delete it with deleteMessage instead.",
"name": "NotBridged"
}
],
"input": {
"encoding": "application/json",
"schema": {
"properties": {
"channel": {
"description": "The linked channel or thread the message lives in.",
"format": "space-ref",
"type": "string"
},
"community": {
"description": "The community the registration belongs to.",
"format": "did",
"type": "string"
},
"reason": {
"description": "Human-readable reason.",
"maxLength": 512,
"type": "string"
},
"registration": {
"description": "Record key of the registration.",
"format": "tid",
"type": "string"
},
"subject": {
"description": "The message to hide.",
"ref": "social.colibri.beta.defs#recordRef",
"type": "ref"
}
},
"required": [
"community",
"registration",
"channel",
"subject"
],
"type": "object"
}
},
"output": {
"encoding": "application/json",
"schema": {
"properties": {},
"type": "object"
}
},
"type": "procedure"
}