Chats

Update chat metadata (title/description) (v2, tenant actor)

Auth: Tenant Actor

Update chat room metadata (Mongo-backed title/description) for tenant actors. Supports User JWT and B2B Server JWT. The {chatId} path value must be the canonical roomJid local part (the stored chat name), for example ${appId}_${roomId}. A full room JID like ${appId}_${roomId}@conference.example.com is also accepted; the domain part is ignored.

patch/v2/apps/{appId}/chats/{chatId}

Request

  • Base URL: https://api.chat.ethora.com
  • URL: https://api.chat.ethora.com/v2/apps/{appId}/chats/{chatId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

appIdstring required

Target App ID. Must be an app the calling actor owns or has been delegated access to.

chatIdstring required

Canonical roomJid local part / chat name, usually ${appId}_${roomId}.

Request body

titlestring

New display title. Propagates to the XMPP MUC room config; live clients see the change next time they fetch chat metadata.

descriptionstring

New short description shown in the chat info panel.

Response 

{
  ok: true,
  result: {
    _id: string,
    name: string,
    title: string,
    description: string,
    type: string,
    picture: string,
    appId: string,
    updatedAt: any
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.