Chats

Create a chat in a target app (v2, tenant actor)

Auth: Tenant Actor

Creates a public or group chat in the explicit target app using the app system account as the room owner. Supports User JWT and B2B Server JWT.

post/v2/apps/{appId}/chats

Request

  • Base URL: https://api.chat.ethora.com
  • URL: https://api.chat.ethora.com/v2/apps/{appId}/chats
  • 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.

Request body

titlestring

Display name shown in the chat list and at the top of the room. Free-form.

uuidstring

Optional caller-supplied unique ID for the chat. If omitted the server generates one. The final chat name is <appId>_<uuid>.

descriptionstring

Optional short description shown beneath the title in the chat info panel.

typestring

public | group

picturestring

Optional URL for the room avatar. Typically uploaded via /v1/files/ first; pass the resulting location here.

membersstring[]

Array of xmppUsername strings (<appId>_<userId>) to add as initial members. The caller's own JID is implicit and does not need to be listed.

Response

ok

Changes

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