Skip to main content
PATCH
Update Conversation
Updates one or more fields on a conversation. Only group and space conversations can be updated — direct conversations return a 400. Authorization:
  • group conversations: caller must be an active admin member.
  • space conversations: caller must have admin or moderator role in the parent Space.

Path Parameters

string
required
The ID of the conversation to update.

Body Parameters

All fields are optional. Only provided fields are updated.
string
New display name for the conversation. Maximum 200 characters.
string
New description. Maximum 1000 characters.
string | null
ID of an uploaded File to use as the conversation avatar. Pass null to remove the current avatar. If a previous avatar exists, it is deleted from storage automatically.
string
Who can post messages. Only valid for space conversations. Accepted values: "members" (any active member), "admins" (only space admins and moderators).

Response

Returns the updated Conversation object, with avatarFile populated if set.

Error Responses