Zendesk - Love your helpdesk.

Show

GET /forums/#{id}.xml
Returns a single forum.

Response

Status: 200

<forum>
  <id>6</id>	
  <name>Announcements</name>	
  <description>New features, fixes, and other important announcements.</description>
  <description-html><p>New features, fixes, and other important announcements.</p></description-html>
  <entries-count>10</entries-count>
  <posts-count>12</posts-count>	
  <is-locked>true</is-locked>
  <is-public>true</is-public>
</forum>

List

GET /forums.xml
Returns all forums.

Response

Status: 200

<forums>
  <forum>
    ...
  </forum>
  <forum>
    ...
  </forum>
</forums>

Create

POST /forums.xml
Creates a new forum.

Request

<forum>	
  <name>This is the name of the forum</name>  
  <description>This is a description of a forum</description>  
  <is-locked type="boolean">false</is-locked>    
  <is-public>true</is-public>
</forum>

Response

Status: 201
Location: http://account.zendesk.com/forums/#{new-forum-id}.xml

Update

PUT /forums/#{id}.xml
Updates an existing forum with details from the submitted XML.

Request

<forum>
  <is_public>false</is_public>   
</forum>

Response

Status: 200

Forum set not to be public, i.e. not visible to end-users.

Destroy

DELETE /forums/#{id}.xml
Destroys the forum with the referenced ID. All related entries (topics) and posts are destroyed as well.

Response

Status: 200