Loading ...

REST API: Create Case Comment | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Cases » REST API: Case Comments » REST API: Create Case Comment
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 16

REST API: Create Case Comment

0 
 /5
0 (0votes)

Create Case Comment

POST /api/case/comments

Creates a case comment on a case. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
POST
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
Case Comment JSON Used in the request body This is JSON that represents a case comment object that you're creating. This should be of the format seen below in the sample given. The required values in this JSON are given below.
CommentText Used in the request body The text entered as the case comment.
IssueID Used in the request body The Issue ID of the case on which the comment has to be made.
Optional Parameters How to use Description
IsInternal Used in the request body Specifies if the comment is an internal comment.
ParentCommentID Used in the request body ID of the comment under which the current comment has to be made.

Example Request

POST https://myintranet.communifire.com/api/case/comments

Body:

{
    "CommentText": "This issue has been resolved.",
    "IssueID": 259
}

Example Response

Comment ID is returned as ResponseData.

{
    "IsError":false,
    "ResponseMessage":"ToBePublished",
    "ResponseData":73
}

Please Note The content type that you pass in the header of your request should be application/json.

Wiki Index

Pages

Intranet Software