Forums API

All Forums
GET  /portal/[PORTALID]/projects/[PROJECTID]/forums/
Add Forum
POST  /portal/[PORTALID]/projects/[PROJECTID]/forums/
Update Forum
POST  /portal/[PORTALID]/projects/[PROJECTID]/forums/[FORUMID]/
Delete Forum
DELETE  /portal/[PORTALID]/projects/[PROJECTID]/forums/[FORUMID]/
All Forum Categories
GET  /portal/[PORTALID]/projects/[PROJECTID]/categories/
Add Category
POST  /portal/[PORTALID]/projects/[PROJECTID]/categories/
All Forum Comments
GET  /portal/[PORTALID]/projects/[PROJECTID]/forums/[FORUMID]/comments/
Add Forum Comment
POST  /portal/[PORTALID]/projects/[PROJECTID]/forums/[FORUMID]/comments/

 All Forums

GET  /portal/[PORTALID]/projects/[PROJECTID]/forums/

Gets all the forums in the given project.

Request Parameters

indexintIndex number of the forum.
rangeintRange of the forums.
category_idLongID of the project category.

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
    "forums": [{
        "id": 170876000001825013,
        "name": "ERP Sysytem",
        "content": "Enterprise resource planning (ERP) integrates internal and external management 
                    information across an entire organization, embracing finance/accounting, manufacturing, 
                    sales and service, etc. ERP systems automate this activity with an integrated software application.",
        "is_sticky_post": false,
        "is_announcement_post": false,
        "posted_by": "2060758",
        "posted_person": "Patricia Boyle",
        "post_date": "05-09-2014 03:52 PM",
        "post_date_long": 1399659763852,
        "link": {
            "self": {
                "url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/
                        170876000000147021/forums/170876000001825013/"
            }
        }
    }]
}

 Add Forum

POST  /portal/[PORTALID]/projects/[PROJECTID]/forums/

Adds the forum post.

Request Parameters

name*StringName of the forum post.
content*StringContent of the forum post.
category_id*LongID of the project category.
uploadfileFileThe file to upload in the forum.
notifyStringUser ID's must be separated by commas for multiple users.

Sample Response

Status: 201 Created

Content Type: application/json;charset=utf-8
{
    "forums": [{
        "id": 170876000001849089,
        "name": "Want ideas for Credit Check redesign?",
        "content": "Team,
                     Credit Check",
        "is_sticky_post": false,
        "is_announcement_post": false,
        "posted_by": "2060758",
        "posted_person": "Patricia Boyle",
        "post_date": "05-26-2014 04:19 PM",
        "post_date_long": 1401130162904,
        "link": {
            "self": {
                "url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/
                        170876000000147021/forums/170876000001849089/"
            }
        }
    }]
}

 Update Forum

POST  /portal/[PORTALID]/projects/[PROJECTID]/forums/[FORUMID]/

Updates the forum post.

Request Parameters

name*StringName of the forum post.
content*StringContent of the forum post.
category_id*LongID of the project category.
uploadfileFileThe file to upload in the forum.

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
    "forums": [{
        "id": 170876000001849089,
        "name": " Credit Check ",
        "content": "Want ideas for Credit Check redesign.",
        "is_sticky_post": false,
        "is_announcement_post": false,
        "posted_by": "2060758",
        "posted_person": "Patricia Boyle",
        "post_date": "05-26-2014 04:19 PM",
        "post_date_long": 1401130162904,
        "link": {
            "self": {
                "url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/
                        170876000000147021/forums/170876000001849089/"
            }
        }
    }]
}

 Delete Forum

DELETE  /portal/[PORTALID]/projects/[PROJECTID]/forums/[FORUMID]/

Deletes the forum post.

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
    "response": "Forum Deleted Successfully"
}

 All Forum Categories

GET  /portal/[PORTALID]/projects/[PROJECTID]/categories/

Gets all the forum categories.

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
    "categories": [{
        "id": 170876000000147025,
        "name": "ERP Phase III"
    }]
}

 Add Category

POST  /portal/[PORTALID]/projects/[PROJECTID]/categories/

Adds the forum category.

Request Parameters

name*StringName of the forum category.

Sample Response

Status: 201 Created

Content Type: application/json;charset=utf-8
{
    "categories": [{
        "id": 170876000001849101,
        "name": "Inventory"
    }]
}

 All Forum Comments

GET  /portal/[PORTALID]/projects/[PROJECTID]/forums/[FORUMID]/comments/

Gets all the forum comments.

Request Parameters

indexStringIndex number of the forum comment.
rangeStringRange of the forum comments.

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
    "comments": [{
        "id": 170876000000505005,
        "content": "Enterprise resource planning (ERP) integrates internal and external 
management information across an entire organization, embracing 
finance/accounting, manufacturing, sales and service, etc. ERP systems 
automate this activity",
        "posted_by": "2060758",
        "posted_person": "Patricia Boyle",
        "post_date": "11-10-2011 10:40 PM",
        "post_date_long": 1320973827168
    }]
}

 Add Forum Comment

POST  /portal/[PORTALID]/projects/[PROJECTID]/forums/[FORUMID]/comments/

Adds the forum comment.

Request Parameters

content*StringContent of the forum comment.

Sample Response

Status: 201 Created

Content Type: application/json;charset=utf-8
{
    "comments": [{
        "id": 170876000001849115,
        "content": "To be uploaded in the new task link.",
        "posted_by": "2060758",
        "posted_person": "Patricia Boyle",
        "post_date": "05-26-2014 04:31 PM",
        "post_date_long": 1401130914687
    }]
}