Skip to content

Function: createRequestComment() ​

ts
function createRequestComment(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  author?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        avatarUrls?: Record<string, any>;
        jiraRest?: string;
        self?: string;
     };
     active?: boolean;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     timeZone?: string;
  };
  body?: string;
  created?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  id?: string;
  public?: boolean;
}>;

Defined in: src/serviceDeskServer/api/customerRequests.ts:64

Add a public or internal comment on an existing customer request. The currently logged-in user will be the author of the comment. The comment visibility is set by the public field.

Permissions:

Setting comment visibility depends on the calling user's permissions. For example, Agents can create either public or internal comments, Unlicensed users can only create internal comments, and Customers can only create public comments.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ body?: string; issueIdOrKey: string; public?: boolean; }-
parameters.body?string-
parameters.issueIdOrKey?stringThe id or key of the customer request.
parameters.public?boolean-
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; author?: { [key: string]: unknown; _links?: { [key: string]: unknown; avatarUrls?: Record<string, any>; jiraRest?: string; self?: string; }; active?: boolean; displayName?: string; emailAddress?: string; key?: string; name?: string; timeZone?: string; }; body?: string; created?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; id?: string; public?: boolean; }>