iFlyChat
  • Documentation
  • Installation
    • WordPress Chat Plugin
    • Drupal Chat Module
    • PHP Chat Client
  • WordPress
    • Embed Chatroom in WordPress Post
    • Disable Popup Chat
    • Hide Popup Chat from a Page
    • Embed Inbox View
    • View Chat Logs
    • Guest User Access
    • Show/Hide Popup Chat On Specific Pages
    • WordPress Filters and Hooks
  • API Reference
    • Create a new chat room
    • Retrieve list of all chat rooms
    • Edit a chat room
    • Retrieve list of all online users
    • Kick a user from the chat
    • Retrieve list of all users online in a chat room
    • Delete a chat room
    • Retrieve Thread History
  • JavaScript SDK
    • Quickstart
    • Custom Label In Chat Window
    • User Chat Button Widget
    • Reference
      • message receive
      • message send
      • user list update
      • connect
      • disconnect
      • ready
      • iflychat.startChat
      • iflychat.closeChat
      • iflychat.minimiseChat
      • iflychat.init
      • iflychat.setStatus
      • iflychat.sound
      • iflychat.openAdminDashboard
      • current user status update
      • current user sound update
      • iflychat.renderLabelInChatWindow
  • Help
    • General
      • Introduction
      • Accounts and Billing
      • Chat Theme and Colors
      • Chat Notification Sound
      • Going Offline
      • Change billing card information
    • Embedded Chatroom
      • Create a New Room
      • Create a New Embed Room
      • Embed Room in PHP
    • Feature Description
      • Moderated Chatroom
      • Group Chat
      • Private Embedded Chatroom
      • Change Guest Name
      • Resize Popup Chat Window
      • Mute Sound Notification
      • Change User Status
      • Desktop Notification
      • Popout or Full Screen Mode
      • Share Media Files
      • Video Chat
    • Chat Moderation
      • Kick/Ban/BanIP
      • Delete or Clear Messages
      • Popup Chat Position
      • Popup Chat Launcher Position
      • App Dashboard
      • Emoji Packs
      • Message Display Format
      • Time Display Format
      • Mobile Web Chat
      • Show Only Admins in Chat
      • Hide Recent Chats Section
      • Hide Users in Popup Chat List
      • Hide Popup Chat List
      • Minimize Popup Chat List
Powered by GitBook
On this page
  • Edit a chat room
  • Curl Command

Was this helpful?

  1. API Reference

Edit a chat room

Learn how to update global or private chat room using iFlyChat REST API

You can use iFlyChat API to programmatically edit any room.

Edit a chat room

POST https://api.iflychat.com/api/1.1/room/:id/edit

Path Parameters

Name
Type
Description

id

string

The id of the chat room to be updated

Request Body

Name
Type
Description

api_key

string

The private API key of your website

room_name

string

The name of the chat room to be updated

room_role

string

The room role identifier. This determines the access to the chat room based upon user role. Use 0 if not sure.

room_private

string

1 if the room is going to be private

room_moderate

string

1 if the chat messages have to be approved before being published in the chat room

{ success: true }

Curl Command

Here is the sample curl command required to make HTTP request:

curl -H "Content-Type: application/json" -X POST https://api.iflychat.com/api/1.1/room/4/edit -d "{\"api_key\":\"Wr4vpoJ_ET3lpBdX9E9TutUic4Dgb-gc7RGzuZvKqZgW55\", \"room_name\": \"room_4\", \"room_role\": \"1\", \"room_private\": \"1\", \"room_moderate\": \"1\"}"
PreviousRetrieve list of all chat roomsNextRetrieve list of all online users

Last updated 5 years ago

Was this helpful?