Plumsail HelpDesk (Preview)

The API allows interact with Plumsail HelpDesk ticketing system. Visit https://plumsail.com/docs/help-desk-o365/v1.x/API/ms-flow.html for more information.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Contact
Name Plumsail
URL https://plumsail.com/sharepoint-helpdesk/support/
Email support@plumsail.com
Connector Metadata
Publisher Fuzor LLC
Website https://plumsail.com/sharepoint-helpdesk/
Privacy policy https://plumsail.com/privacy-policy/helpdesk/

Creating a connection

To connect your account, you will need the following information:

Name Type Description
API Key securestring

The API Key for this api

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Create a comment

Creates new comment for a ticket with specified ID and returns it.

Create a contact

Creates new contact and returns it.

Create a ticket

Creates new ticket and returns created ticket.

Create an organization

Creates new item in Organizations list and return it

Delete a contact

Deletes contact by Id

Delete a ticket

Deletes ticket by Id.

Delete an organization

Deletes organization by Id.

Delete an organization by title

Deletes organization by title

Download attachment

Returns attachment file for specific ticket by its name, or returns error code

Get a single comment

Gets a comment by ID and returns it.

Get a single contact by Email

Gets a contact by email and returns it.

Get a single contact by Id

Gets a contact by Id and returns it.

Get a single organization

Gets an organization by Id and returns it.

Get a single organization by title

Gets an organization by title and returns it.

Get a single ticket

Gets a ticket by Id and returns it

Get all comments for a ticket

Gets all comments for a ticket with specified Id.

Get contacts

Get contacts. By default this action returns first 50 contacts.

Get organizations

Get organizations. By default this action returns first 50 organizations.

Get tickets

Get tickets. By default this action returns first 50 tickets.

Update a contact

Finds a contact by Id and updates it. Returns updated contact.

Update a contact by Email

Finds a contact by email and updates it. Returns updated contact.

Update a ticket

Gets a ticket by Id and updates it. Returns updated ticket.

Update an organization

Updates an organization by Id and returns it.

Update an organization by title

Gets an organization by title and updates it. Returns updated organization.

Create a comment

Creates new comment for a ticket with specified ID and returns it.

Parameters

Name Key Required Type Description
Attachment File Name
Name True string

Creates new comment for a ticket with specified ID and returns it.

AttachmentContent
AttachmentContent True binary

File Content

Comment Body
body True string

Creates new comment for a ticket with specified ID and returns it.

Comment Author Email
fromEmail True string

Creates new comment for a ticket with specified ID and returns it.

Comment MessageId
messageId string

Creates new comment for a ticket with specified ID and returns it.

Ticket Id
ticketId True integer

Ticket Id

Returns

Create a contact

Creates new contact and returns it.

Parameters

Name Key Required Type Description
Contact Name
title True string

Creates new contact and returns it.

Contact Email
email True string

Creates new contact and returns it.

Contact SPUserId
spUserId integer

Creates new contact and returns it.

Contact Role
role string

Creates new contact and returns it.

Contact Alternate Email
emailAlternate string

Creates new contact and returns it.

Update if exists
updateIfExists boolean

Update contact if it already exists

Returns

Create a ticket

Creates new ticket and returns created ticket.

Parameters

Name Key Required Type Description
Ticket Subject
subject True string

Creates new ticket and returns created ticket.

Ticket Body
body True string

Creates new ticket and returns created ticket.

Ticket Requester Email
requesterEmail True string

Creates new ticket and returns created ticket.

Ticket Assignee Email or SharePoint Group Name
assignedToEmail string

Creates new ticket and returns created ticket.

Ticket Status
status string

Creates new ticket and returns created ticket.

Ticket Category
category string

Creates new ticket and returns created ticket.

Ticket Priority
priority string

Creates new ticket and returns created ticket.

Ticket DueDate
dueDate date-time

Creates new ticket and returns created ticket.

Ticket Cc Emails
Ticket Cc Emails string

Creates new ticket and returns created ticket.

Ticket Tags Titles
Ticket Tags Titles string

Creates new ticket and returns created ticket.

Ticket SupportChannel
supportChannel string

Creates new ticket and returns created ticket.

Attachment File Name
Name True string

Creates new ticket and returns created ticket.

AttachmentContent
AttachmentContent True binary

File Content

Returns

Body
TicketRead

Create an organization

Creates new item in Organizations list and return it

Parameters

Name Key Required Type Description
Organization Title
title True string

Creates new item in Organizations list and return it

Returns

Delete a contact

Deletes contact by Id

Parameters

Name Key Required Type Description
Contact Id
id True integer

Contact Id

Delete a ticket

Deletes ticket by Id.

Parameters

Name Key Required Type Description
Ticket Id
id True integer

Ticket Id

Delete an organization

Deletes organization by Id.

Parameters

Name Key Required Type Description
Organization Id
id True integer

Organization Id

Delete an organization by title

Deletes organization by title

Parameters

Name Key Required Type Description
Organization title
title True string

Organization title

Download attachment

Returns attachment file for specific ticket by its name, or returns error code

Parameters

Name Key Required Type Description
Ticket Id
id True integer

Ticket Id

Attachment Filename
filename True string

Attachment Filename

Get a single comment

Gets a comment by ID and returns it.

Parameters

Name Key Required Type Description
Ticket Id
ticketId True integer

Ticket Id

Comment Id
id True integer

Comment Id

$select
$select string

An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields.

$expand
$expand string

An ODATA $expand query option to specify that the request returns the values of lookups.

Returns

Get a single contact by Email

Gets a contact by email and returns it.

Parameters

Name Key Required Type Description
Contact Email
email True string

Contact Email

$select
$select string

An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields.

$expand
$expand string

An ODATA $expand query option to specify that the request returns the values of lookups.

Returns

Get a single contact by Id

Gets a contact by Id and returns it.

Parameters

Name Key Required Type Description
Contact Id
id True integer

Contact Id

$select
$select string

An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields.

$expand
$expand string

An ODATA $expand query option to specify that the request returns the values of lookups.

Returns

Get a single organization

Gets an organization by Id and returns it.

Parameters

Name Key Required Type Description
Organization Id
id True integer

Organization Id

$select
$select string

An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields.

$expand
$expand string

An ODATA $expand query option to specify that the request returns the values of lookups.

Returns

Get a single organization by title

Gets an organization by title and returns it.

Parameters

Name Key Required Type Description
Organization title
title True string

Organization title

$select
$select string

An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields.

$expand
$expand string

An ODATA $expand query option to specify that the request returns the values of lookups.

Returns

Get a single ticket

Gets a ticket by Id and returns it

Parameters

Name Key Required Type Description
Ticket Id
id True integer

Ticket Id

$select
$select string

An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields.

$expand
$expand string

An ODATA $expand query option to specify that the request returns the values of lookups.

Returns

Body
TicketRead

Get all comments for a ticket

Gets all comments for a ticket with specified Id.

Parameters

Name Key Required Type Description
Ticket Id
ticketId True integer

Ticket Id

$select
$select string

An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields.

$expand
$expand string

An ODATA $expand query option to specify that the request returns the values of lookups.

$filter
$filter string

An ODATA $filter query option to restrict the entries returned

$orderBy
$orderBy string

An ODATA $orderBy query option for specifying the order of entries.

Returns

Get contacts

Get contacts. By default this action returns first 50 contacts.

Parameters

Name Key Required Type Description
$select
$select string

An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields.

$expand
$expand string

An ODATA $expand query option to specify that the request returns the values of lookups.

$filter
$filter string

An ODATA $filter query option to restrict the entries returned

$orderBy
$orderBy string

An ODATA $orderBy query option for specifying the order of entries.

$top
$top integer

An ODATA $top query option to select the first n items of the return set for return (default = 50, maximum = 100).

$skiptoken
$skiptoken string

An ODATA $skiptoken query option to skip over items until the specified item is reached and return the rest.

Returns

Get organizations

Get organizations. By default this action returns first 50 organizations.

Parameters

Name Key Required Type Description
$select
$select string

An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields.

$expand
$expand string

An ODATA $expand query option to specify that the request returns the values of lookups.

$filter
$filter string

An ODATA $filter query option to restrict the entries returned

$orderBy
$orderBy string

An ODATA $orderBy query option for specifying the order of entries.

$top
$top integer

An ODATA $top query option to select the first n items of the return set for return (default = 50, maximum = 100).

$skiptoken
$skiptoken string

An ODATA $skiptoken query option to skip over items until the specified item is reached and return the rest.

Returns

Get tickets

Get tickets. By default this action returns first 50 tickets.

Parameters

Name Key Required Type Description
$select
$select string

An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields.

$expand
$expand string

An ODATA $expand query option to specify that the request returns the values of lookups.

$filter
$filter string

An ODATA $filter query option to restrict the entries returned

$orderBy
$orderBy string

An ODATA $orderBy query option for specifying the order of entries.

$top
$top integer

An ODATA $top query option to select the first n items of the return set for return (default = 50, maximum = 100).

$skiptoken
$skiptoken string

An ODATA $skiptoken query option to skip over items until the specified item is reached and return the rest.

Returns

Update a contact

Finds a contact by Id and updates it. Returns updated contact.

Parameters

Name Key Required Type Description
Contact Id
id True integer

Contact Id

Contact Name
title True string

Contact Id

Contact Email
email True string

Contact Id

Contact SPUserId
spUserId integer

Contact Id

Contact Role
role string

Contact Id

Contact Alternate Email
emailAlternate string

Contact Id

Returns

Update a contact by Email

Finds a contact by email and updates it. Returns updated contact.

Parameters

Name Key Required Type Description
Contact Email
email True string

Contact email

Contact Name
title True string

Contact email

Contact Email
email True string

Contact email

Contact SPUserId
spUserId integer

Contact email

Contact Role
role string

Contact email

Contact Alternate Email
emailAlternate string

Contact email

Returns

Update a ticket

Gets a ticket by Id and updates it. Returns updated ticket.

Parameters

Name Key Required Type Description
Ticket Id
id True integer

Ticket Id

Ticket Subject
subject True string

Ticket Id

Ticket Body
body True string

Ticket Id

Ticket Requester Email
requesterEmail True string

Ticket Id

Ticket Assignee Email or SharePoint Group Name
assignedToEmail string

Ticket Id

Ticket Status
status string

Ticket Id

Ticket Category
category string

Ticket Id

Ticket Priority
priority string

Ticket Id

Ticket DueDate
dueDate date-time

Ticket Id

Ticket Cc Emails
Ticket Cc Emails string

Ticket Id

Ticket Tags Titles
Ticket Tags Titles string

Ticket Id

Ticket SupportChannel
supportChannel string

Ticket Id

Attachment File Name
Name True string

Ticket Id

AttachmentContent
AttachmentContent True binary

File Content

Returns

Body
TicketRead

Update an organization

Updates an organization by Id and returns it.

Parameters

Name Key Required Type Description
Organization Id
id True integer

Organization Id

Organization Title
title True string

Organization Id

Returns

Update an organization by title

Gets an organization by title and updates it. Returns updated organization.

Parameters

Name Key Required Type Description
Organization title
title True string

Organization title

Organization Title
title True string

Organization title

Returns

Definitions

TicketRead

Name Path Type Description
Ticket Subject
subject string
requester
requester Requester
assignedTo
assignedTo Assignee
Ticket Status
status string
Ticket Category
category string
Ticket Priority
priority string
Ticket Due Date
dueDate date-time
Ticket Creation Date
created date-time
Ticket Resolution Date
resolutionDate date-time
Ticket Cc
cc array of Cc
Ticket Tags
tags array of TagRead
Ticket Attachments
attachments array of string
Ticket ID
id integer
Ticket Custom Fields
customFields object

JSON string containing custom field values

Requester

Name Path Type Description
Requester ID
id integer
Requester Full Name
title string
Requester Email
email string
Requester SPUserId
spUserId integer
Requester Role
role string
Requester Alternate Email
emailAlternate string
Requester CustomFields
customFields object

JSON string containing custom field values

Assignee

Name Path Type Description
Assignee ID
id integer
Assignee Full Name
title string
Assignee Email
email string
Assignee SPUserId
spUserId integer
Assignee Role
role string
Assignee Alternate Email
emailAlternate string
Assignee CustomFields
customFields object

JSON string containing custom field values

Cc

Name Path Type Description
Cc ID
id integer
Cc Full Name
title string
Cc Email
email string
Cc SPUserId
spUserId integer
Cc Role
role string
Cc Alternate Email
emailAlternate string
Cc CustomFields
customFields object

JSON string containing custom field values

TagRead

Name Path Type Description
Tag Title
title string
Tag ID
id integer
Tag Custom Fields
customFields object

JSON string containing custom field values

CommentRead

Name Path Type Description
Comment Body
body string
Comment Creation Date
created date-time
Comment Author Email
fromEmail string
Comment Author Name
fromName string
Comment MessageId
messageId string
Comment ID
id integer
Comment Custom Fields
customFields object

JSON string containing custom field values

ContactRead

Name Path Type Description
Contact Full Name
title string
Contact Email
email string
Contact SPUserId
spUserId integer
Contact Role
role string
Contact Alternate Email
emailAlternate string
Contact ID
id integer
Contact Custom Fields
customFields object

JSON string containing custom field values

OrganizationRead

Name Path Type Description
Organization Title
title string
Organization ID
id integer
Organization Custom Fields
customFields object

JSON string containing custom field values