API Method: PUT room

Updates the room info.

Path:

/api/v2/rooms/#{room_id}.#{format}

Formats:

xml, json

HTTP Method(s):

PUT, POST (with the added parameter _method=PUT)

Parameters:

Note that all parameters are encapsulated within a room array (see example)

  • title Optional. The title of the room.
  • is_public Optional. Whether your room is public or private. Values can be true for public and false for private.
  • topic Optional. The topic of the room.
  • greeting_text Optional. New people will be greeted with this text.

Usage examples:

$ curl -u api_token:x -X PUT -d "room[title]=Designers" https://bigbang.jaconda.im/api/v2/rooms/developers.xml

Response:

XML example:

<?xml version="1.0" encoding="UTF-8"?>
<room>
  <created-at type="datetime">2011-02-25T14:38:59+05:00</created-at>
  <greeting-text>Welcome to Developers chat. Type !help to see available commands.</greeting-text>
  <is-public type="boolean">false</is-public>
  <jid>developers</jid>
  <title>Designers</title>
  <topic nil="true"></topic>
  <updated-at type="datetime">2011-02-25T14:46:13+05:00</updated-at>
  <icon-url>https://jaconda.im/images/defaultJacondaIcon.png</icon-url>
</room>