Set or clear a conversation's shared nickname.
Input
Encoding
application/jsonconversationId
string
Required
No description available.
nickname
string
Optional
No description available.
maxLength: 640 bytesmaxGraphemes: 64 graphemesOutput
Encoding
application/jsonnickname
string
Optional
No description available.
Errors
InvalidRequest
NotFound
Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "Set or clear a conversation's shared nickname.",
"errors": [
{
"name": "InvalidRequest"
},
{
"name": "NotFound"
}
],
"input": {
"encoding": "application/json",
"schema": {
"properties": {
"conversationId": {
"type": "string"
},
"nickname": {
"maxGraphemes": 64,
"maxLength": 640,
"type": "string"
}
},
"required": [
"conversationId"
],
"type": "object"
}
},
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"nickname": {
"type": "string"
}
},
"type": "object"
}
},
"type": "procedure"
}