TAtamtam
chats

Edit chat info

Changed on

Edits chat info: title, icon, etc…

patch/chats/{chatId}

Request

  • Base URL
    https://botapi.tamtam.chat
  • URL
    https://botapi.tamtam.chat/chats/{chatId}
  • Auth
    API key in query parameter access_token

Path parameters

chatIdinteger required

Chat identifier

Request body

titlestring nullable
pinstring nullable

Identifier of message to be pinned in chat. In case you want to remove pin, use unpin method

notifyboolean nullable

By default, participants will be notified about change with system message in chat/channel

Response

If success, returns updated chat object

chat_idinteger required

Chats identifier

type'dialog' | 'chat' | 'channel' required

Type of chat. Dialog (one-on-one), chat or channel

status'active' | 'removed' | 'left' | 'closed' | 'suspended' required

Chat status for current bot

titlestring nullable required

Visible title of chat. Can be null for dialogs

last_event_timeinteger required

Time of last event occurred in chat

participants_countinteger required

Number of people in chat. Always 2 for dialog chat type

owner_idinteger nullable

Identifier of chat owner. Visible only for chat admins

participantsobject nullable

Participants in chat with time of last activity. Can be null when you request list of chats. Visible for chat admins only

is_publicboolean required

Is current chat publicly available. Always false for dialogs

linkstring nullable

Link on chat

descriptionstring nullable required

Chat description

messages_countinteger nullable

Messages count in chat. Only for group chats and channels. Not available for dialogs

chat_message_idstring nullable

Identifier of message that contains chat button initialized chat

Changes

  • 137e3d1e0b4fRevision changes
    • info

      added highlighted discriminator mapping keys to the /////////// response property for the response status

    • info

      added highlighted discriminator mapping keys to the //////////////// response property for the response status

    • info

      removed code discriminator mapping keys from the /////////// response property for the response status

    • info

      removed code discriminator mapping keys from the //////////////// response property for the response status

  • dc45288cfedcRevision changes
    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the required property ///////// to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property /////////////// to the response with the status

    • info

      added the required property ////////// to the response with the status