Skip to main content
PATCH
/
chats
/
{userUuid}
Update chat properties
curl --request PATCH \
  --url https://api.example.com/chats/{userUuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Fanvue-API-Version: <x-fanvue-api-version>' \
  --data '
{
  "isRead": true,
  "isMuted": true,
  "nickname": "<string>"
}
'
{
  "error": "<string>",
  "message": "<string>"
}
Required scope
  • write:chat — Create new chats and send messages. This scope is required for any chat-related actions that modify data.

Authorizations

Authorization
string
header
required

OAuth 2.0 access token, presented as a JWT bearer token in the Authorization header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call.

Headers

X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Path Parameters

userUuid
string<uuid>
required

Body

application/json
isRead
boolean

Whether the chat should be marked as read (true) or unread (false)

isMuted
boolean

Whether the chat should be muted (true) or unmuted (false)

nickname
string

Custom nickname for the chat counterpart (max 30 characters)

Maximum string length: 30

Response

Chat updated successfully