Page Comparison

...

This section provides further details on the operations related to companiesforums.

Anchor
createForum createForum

Creates a new forum

The createForum operation creates a new companyforum.

<freshdesk.createForum>
    <name>{$ctx:name}</name>
    <categoryId>{$ctx:categoryId}</categoryId>
    <forumType>{$ctx:forumType}</forumType>
    <forumVisibility>{$ctx:forumVisibility}</forumVisibility>
    <companyIds>{$ctx:companyIds}</companyIds>
    <description>{$ctx:description}</description>
</freshdesk.createForum>

Properties

• name: Name of the forum.
• categoryId: ID of the category to which this forum belongs.

• forumType: Denotes the type of forum.

• forumVisibility: Denotes the visibility level of the forum.

• companyIds: This property is an array of those company IDs.

• description: Description of the forum.

 

Anchor
request request

Sample request

...

<freshdesk.getForum>
    <forumId>{$ctx:forumId}</forumId>
</freshdesk.getForum>

Properties

• forumId: The unique identifier of the forum.

 

Anchor
request request

Sample request

...

<freshdesk.updateForum>
    <forumId>{$ctx:forumId}</forumId>
    <name>{$ctx:name}</name>
    <forumCategoryId>{$ctx:forumCategoryId}</forumCategoryId>
    <forumType>{$ctx:forumType}</forumType>
    <forumVisibility>{$ctx:forumVisibility}</forumVisibility>
    <companyIds>{$ctx:companyIds}</companyIds>
    <description>{$ctx:description}</description>
</freshdesk.updateForum>

Properties

• name: Name of the forum.
• forumId: ID f the forum.
• forumCategoryId: ID of the category to which this forum belongs.

• forumType: Denotes the type of forum.

• forumVisibility: Denotes the visibility level of the forum.

• companyIds: This property is an array of those company IDs.

• description: Description of the forum.

 

Anchor
request request

Sample request

...