Update viewer info in chatroom
PUThttps://api.one.blendvision.com/bv/chatroom/v1/chatrooms/viewer-infos
Modifies viewer information within the chatroom.
Authorization requires the chatroom token with the admin
role.
Request
Header Parameters
authorization string
This API should be invoked with the chatroom token.
- application/json
Body
required
viewer_info objectrequired
action_taker objectrequired
Responses
- 200
- 400
- 401
- 403
- 500
- default
A successful response.
- application/json
- Schema
- Example (from schema)
Schema
object
{}
A bad request response.
The code
is 3
means got an invalid argument. There are more HTTP status code mappings listed on here and gRPC code on here.
- application/json
- Schema
- Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A unauthenticated response.
The header authorization
was missing or unidentified.
- application/json
- Schema
- Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A forbidden response.
It means that the provided authorization
did not have enough permission to access the resource or the API.
- application/json
- Schema
- Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A server error response. There are more HTTP status code mappings listed on here.
- application/json
- Schema
- Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- Schema
- Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Authorization: authorization
name: authorizationtype: apiKeydescription: Enter the token with Bearer schema prefix, eg. `Bearer <token-string>`in: header
- curl
- python
- go
- nodejs
- php
- CURL
curl -L -X PUT 'https://api.one.blendvision.com/bv/chatroom/v1/chatrooms/viewer-infos' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'authorization: <API_KEY_VALUE>' \
-d '{
"viewer_info": {
"enabled": true
},
"action_taker": {
"custom_name": "string"
}
}'
ResponseClear