Skip to content

Function: getSubscriptionStatus() ​

ts
function getSubscriptionStatus(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  subscribed?: boolean;
}>;

Defined in: src/serviceDesk/api/request.ts:491

This method returns the notification subscription status of the user making the request. Use this method to determine if the user is subscribed to a customer request's notifications.

Permissions required: Permission to view the customer request.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ issueIdOrKey: string; }-
parameters.issueIdOrKeystringThe ID or key of the customer request to be queried for subscription status.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; subscribed?: boolean; }>