Leaves a conversation (direct or group). For group, this effectively removes membership. For direct, membership is never removed, only changed to remove from enumerations by the user who left.
Input
Encoding
application/jsonconvoId
string
Required
No description available.
Output
Encoding
application/jsonconvoId
string
Required
No description available.
rev
string
Required
No description available.
Errors
InvalidConvo
AlreadyLeftConvo
The user has already left the conversation and is not back in (a direct conversation can be restarted by a new message, which allows leaving again). OwnerCannotLeave
The owner of a group conversation cannot leave before locking the group. 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": [
"convoId"
],
"properties": {
"convoId": {
"type": "string"
}
}
},
"encoding": "application/json"
},
"errors": [
{
"name": "InvalidConvo"
},
{
"name": "AlreadyLeftConvo",
"description": "The user has already left the conversation and is not back in (a direct conversation can be restarted by a new message, which allows leaving again)."
},
{
"name": "OwnerCannotLeave",
"description": "The owner of a group conversation cannot leave before locking the group."
}
],
"output": {
"schema": {
"type": "object",
"required": [
"convoId",
"rev"
],
"properties": {
"rev": {
"type": "string"
},
"convoId": {
"type": "string"
}
}
},
"encoding": "application/json"
},
"description": "Leaves a conversation (direct or group). For group, this effectively removes membership. For direct, membership is never removed, only changed to remove from enumerations by the user who left."
}