Microsoft Flow Actions

This connector helps you to manipulate data in your HelpDesk with the help of Microsoft Flow. Before starting, ensure that you added Plumsail HelpDesk connector to Microsoft Flow.

Get tickets

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

Output Parameters

Parameter Description Example
Tickets Array of tickets. All custom fields listed in $select parameter are returned in the customFields object.

Example of ticket in JSON format:

{
    "subject": "Site issues",
    "requester": { ... },
    "assignedTo": { ... },
    "status": "In progress",
    "category": "Question",
    "priority": "High",
    "dueDate": "2018-04-27",
    "created": "2018-04-27,
    "resolutionDate": "",
    "cc": [],
    "tags": [],
    "attachments": null,
    "id": 1,
    "customFields": {}
}

Input Parameters

Parameter Description Example
includeAttachments By default result will not contain any attachments. To load ticket attachments you must set parameter "includeAttachments" to Yes. Yes
$select An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. SupportChannel,HelpDeskMailbox,Metadata/IsRead
$expand An ODATA $expand query option to specify that the request returns the values of lookups. Metadata
$filter An ODATA $filter query option to restrict the entries returned Priority eq 'High'
$orderBy An ODATA $orderBy query option for specifying the order of entries. ID desc
$top An ODATA $top query option to select the first n items of the return set for return (default = 50, maximum = 100). 100
$skiptoken An ODATA $skiptoken query option to skip over items until the specified item is reached and return the rest. Paged=TRUE&p_ID=100

Example

Get tickets example

Create a ticket

Creates new ticket and returns created ticket.

Output Parameters

Parameter Description Example
Ticket Created ticket. All custom fields listed in $select parameter are returned in the customFields object.

Example of ticket in JSON format:

{
    "subject": "Site issues",
    "requester": { ... },
    "assignedTo": { ... },
    "status": "In progress",
    "category": "Question",
    "priority": "High",
    "dueDate": "2018-04-27",
    "created": "2018-04-27,
    "resolutionDate": "",
    "cc": [],
    "tags": [],
    "attachments": null,
    "id": 1,
    "customFields": {}
}

Input Parameters

Parameter Description Example
Ticket Subject Subject Printer issues
Ticket Body Body My printer is not working, please help ASAP.
Ticket Requester Email Requester email j.davis@example.com
Ticket Assignee Email or Sharepoint Group Assignee email or the name of SharePoint group to which the ticket will be assigned to. j.davis@example.com or IT support
Ticket Status Status name In progress
Ticket Category Category name Problem
Ticket Priority Priority name High
Ticket DueDate DueDate 01.05.2018
Ticket Cc Emails Array if Cc emails ["j.davis@example.com", "m.smith@example.com"]
Ticket Tags tagTitles Array of ticket tags, new tags will be created in Tags list automatically. ["Printers", "MS Windows"]
Ticket Attachments Array of object containing File Names and File Contents.

File Name: screenshot.png

File Content: You can extract file content from other connectors like:

  • SharePoint
  • Salesforce
  • Box
  • OneDrive
  • Google Drive
  • Dropbox
  • SFTP
  • File System

List of Microsoft Flow connectors

Ticket Support Channel Support channel name, if no value is provided, it will be set to API Company site
Ticket Custom Fields JSON object with custom field values to be set.
{
    "Location": "Europe",
    "OperatingSystem": "MS Windows 10"
}

Example

Create ticket example

Delete a ticket

Deletes a ticket by ID.

Input Parameters

Parameter Description Example
ID Ticket ID to delete 1

Example

Delete a ticket example

Get a single ticket

Gets a single ticket by ID and returns it.

Output Parameters

Parameter Description Example
Ticket Requested ticket. All custom fields listed in $select parameter are returned in the customFields object.

Example of ticket in JSON format:

{
    "subject": "Site issues",
    "requester": { ... },
    "assignedTo": { ... },
    "status": "In progress",
    "category": "Question",
    "priority": "High",
    "dueDate": "2018-04-27",
    "created": "2018-04-27,
    "resolutionDate": "",
    "cc": [],
    "tags": [],
    "attachments": null,
    "id": 1,
    "customFields": {}
}

Input Parameters

Parameter Description Example
ID Ticket ID 15
includeAttachments By default result will not contain any attachments. To load ticket attachments you must set parameter "includeAttachments" to Yes. Yes
$select An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. SupportChannel,HelpDeskMailbox,Metadata/IsRead
$expand An ODATA $expand query option to specify that the request returns the values of lookups. Metadata

Example

Get ticket by ID example

Update a ticket

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

Output Parameters

Parameter Description Example
Ticket Updated ticket.

Example of ticket in JSON format:

{
    "subject": "Site issues",
    "requester": { ... },
    "assignedTo": { ... },
    "status": "In progress",
    "category": "Question",
    "priority": "High",
    "dueDate": "2018-04-27",
    "created": "2018-04-27,
    "resolutionDate": "",
    "cc": [],
    "tags": [],
    "attachments": null,
    "id": 1,
    "customFields": {}
}

Input Parameters

Parameter Description Example
Ticket Subject Subject Printer issues
Ticket Body Body My printer is not working, please help ASAP.
Ticket Requester Email Requester email j.davis@example.com
Ticket Assignee Email or Sharepoint Group Assignee email or the name of SharePoint group to which the ticket will be assigned to. j.davis@example.com or IT support
Ticket Status Status name In progress
Ticket Category Category name Problem
Ticket Priority Priority name High
Ticket DueDate DueDate 01.05.2018
Ticket Cc Emails Array if Cc emails ["j.davis@example.com", "m.smith@example.com"]
Ticket Tags tagTitles Array of ticket tags, new tags will be created in Tags list automatically. ["Printers", "MS Windows"]
Ticket Attachments Array of object containing File Names and File Contents.

File Name: screenshot.png

File Content: You can extract file content from other connectors like:

  • SharePoint
  • Salesforce
  • Box
  • OneDrive
  • Google Drive
  • Dropbox
  • SFTP
  • File System

List of Microsoft Flow connectors

Ticket Support Channel Support channel name, if no value is provided, it will be set to API Company site
Ticket Custom Fields JSON object with custom field values to be set.
{
    "Location": "Europe",
    "OperatingSystem": "MS Windows 10"
}

Example

Update a ticket example

Get all comments for a ticket

Gets all comments for a ticket with specified Id.

Output Parameters

Parameter Description Example
Comments Array of comments. All custom fields listed in $select parameter are returned in the customFields object.

Example of comment in JSON format:

{
    "body": "The issue is still not resolved!",
    "created": "2018-04-28T09:48:07Z",
    "fromEmail": "j.jones@example.com",
    "fromName": "James Jones",
    "messageId": null,
    "id": 25,
    "customFields": {}
}

Input Parameters

Parameter Description Example
ticketId Ticket ID 1
$select An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. CommentType,From/Role
$expand An ODATA $expand query option to specify that the request returns the values of lookups. From
$filter An ODATA $filter query option to restrict the entries returned CommentType eq 'Reply'
$orderBy An ODATA $orderBy query option for specifying the order of entries. ID desc

Example

Get comments example

Create a comment

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

Output Parameters

Parameter Description Example
Comment Created comment

Example of comment in JSON format:

{
    "body": "The issue is still not resolved!",
    "created": "2018-04-28T09:48:07Z",
    "fromEmail": "j.jones@example.com",
    "fromName": "James Jones",
    "messageId": null,
    "id": 25,
    "customFields": {}
}

Input Parameters

Parameter Description Example
ticketId Ticket ID 1
Comment Body Body of the comment The issue is still not resolved!
Comment Author Email Email of the author of the comment j.jones@example.com
Attachments Array of object containing File Names and File Contents.

File Name: screenshot.png

File Content: You can extract file content from other connectors like:

  • SharePoint
  • Salesforce
  • Box
  • OneDrive
  • Google Drive
  • Dropbox
  • SFTP
  • File System

List of Microsoft Flow connectors

Comment MessageId Message-ID of email message, if comment is being created from email <SN2PR0501MB105.namprd05.prod.outlook.com>
Comment Custom Fields JSON object with custom field values to be set for comment.
{
    "Location": "Europe",
    "OperatingSystem": "MS Windows 10"
}

Example

Create comment example

Get a single comment

Gets a comment by Id and returns it.

Output Parameters

Parameter Description Example
Comment Comment

Example of comment in JSON format:

{
    "body": "The issue is still not resolved!",
    "created": "2018-04-28T09:48:07Z",
    "fromEmail": "j.jones@example.com",
    "fromName": "James Jones",
    "messageId": null,
    "id": 25,
    "customFields": {}
}

Input Parameters

Parameter Description Example
id Comment ID 1
$select An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. CommentType,From/Role
$expand An ODATA $expand query option to specify that the request returns the values of lookups. From

Example

Get comments example

Get contacts

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

Output Parameters

Parameter Description Example
Contacts Array of contacts. All custom fields listed in $select parameter are returned in the customFields object.

Example of contact in JSON format:

{
    "title": "Mary Smith",
    "email": "m.smith@example.com",
    "spUserId": 0,
    "role": "End-User",
    "emailAlternate": "m.smith@google.com",
    "id": 20,
    "customFields": {}
}

Input Parameters

Parameter Description Example
$select An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. PhoneNumber,IsValidated,Organization/Title
$expand An ODATA $expand query option to specify that the request returns the values of lookups. Organization
$filter An ODATA $filter query option to restrict the entries returned Role eq 'Agent'
$orderBy An ODATA $orderBy query option for specifying the order of entries. ID desc
$top An ODATA $top query option to select the first n items of the return set for return (default = 50, maximum = 100). 100
$skiptoken An ODATA $skiptoken query option to skip over items until the specified item is reached and return the rest. Paged=TRUE&p_ID=100

Example

Get contacts example

Create a contact

Creates new contact and returns it.

Output Parameters

Parameter Description Example
Contact All custom fields listed in $select parameter are returned in the customFields object.

Example of contact in JSON format:

{
    "title": "Mary Smith",
    "email": "m.smith@example.com",
    "spUserId": 0,
    "role": "End-User",
    "emailAlternate": "m.smith@google.com",
    "id": 20,
    "customFields": {}
}

Input Parameters

Parameter Description Example
updateIfExists If contact with specified email already exists and updateIfExists parameter is set to Yes, contact information will be updated Yes
Contact Name Full name of the contact Mary Cane
Contact Email Email of the contact m.cane@example.com
Contact SPUserId You can provide SPUser ID instead of contact email, if you want to create Agent or Member 15
Contact Role Role of the contact in HelpDesk En-User, Member or Agent
Contact Alterate Email Alterate email address for the contact m.cane@outlook.com
Contact Custom Fields JSON object with custom field values to be set.
{
    "Location": "USA",
    "PhoneNumber": "(123)123-1234"
}

Example

Create contact example

Get a single contact by Email

Gets a contact by email and returs it.

Output Parameters

Parameter Description Example
Requested contact All custom fields listed in $select parameter are returned in the customFields object.

Example of contact in JSON format:

{
    "title": "Mary Smith",
    "email": "m.smith@example.com",
    "spUserId": 0,
    "role": "End-User",
    "emailAlternate": "m.smith@google.com",
    "id": 20,
    "customFields": {}
}

Input Parameters

Parameter Description Example
email Contact email m.cane@example.com
$select An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. PhoneNumber,IsValidated,Organization/Title
$expand An ODATA $expand query option to specify that the request returns the values of lookups. Organization

Example

Get contact by email example

Update a contact by Email

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

Output Parameters

Parameter Description Example
Contact Updated contact

Example of contact in JSON format:

{
    "title": "Mary Smith",
    "email": "m.smith@example.com",
    "spUserId": 0,
    "role": "End-User",
    "emailAlternate": "m.smith@google.com",
    "id": 20,
    "customFields": {}
}

Input Parameters

Parameter Description Example
Contact Email Email of the contact m.cane@example.com
Contact Name Full name of the contact Mary Cane
Contact SPUserId You can provide SPUser ID instead of contact email, if you want to create Agent or Member 15
Contact Role Role of the contact in HelpDesk En-User, Member or Agent
Contact Alterate Email Alterate email address for the contact m.cane@outlook.com
Contact Custom Fields JSON object with custom field values to be set.
{
    "Location": "USA",
    "PhoneNumber": "(123)123-1234"
}

Example

Update contact by email example

Delete a contact

Deletes a contact by ID.

Input Parameters

Parameter Description Example
id Contact ID to delete 1

Example

Delete a contact example

Get a single contact by ID

Gets a contact by ID and returs it.

Output Parameters

Parameter Description Example
Requested contact All custom fields listed in $select parameter are returned in the customFields object.

Example of contact in JSON format:

{
    "title": "Mary Smith",
    "email": "m.smith@example.com",
    "spUserId": 0,
    "role": "End-User",
    "emailAlternate": "m.smith@google.com",
    "id": 20,
    "customFields": {}
}

Input Parameters

Parameter Description Example
id Contact ID 20
$select An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. PhoneNumber,IsValidated,Organization/Title
$expand An ODATA $expand query option to specify that the request returns the values of lookups. Organization

Example

Get contact by ID example

Update a contact by ID

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

Output Parameters

Parameter Description Example
Contact Updated contact

Example of contact in JSON format:

{
    "title": "Mary Smith",
    "email": "m.smith@example.com",
    "spUserId": 0,
    "role": "End-User",
    "emailAlternate": "m.smith@google.com",
    "id": 20,
    "customFields": {}
}

Input Parameters

Parameter Description Example
id Contact ID 20
Contact Name Full name of the contact Mary Cane
Contact Email Email of the contact m.cane@example.com
Contact SPUserId You can provide SPUser ID instead of contact email, if you want to create Agent or Member 15
Contact Role Role of the contact in HelpDesk En-User, Member or Agent
Contact Alterate Email Alterate email address for the contact m.cane@outlook.com
Contact Custom Fields JSON object with custom field values to be set.
{
    "Location": "USA",
    "PhoneNumber": "(123)123-1234"
}

Example

Update contact by ID example

Get organizations

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

Output Parameters

Parameter Description Example
Organizations Array of organizations. All custom fields listed in $select parameter are returned in the customFields object.

Example of Organization in JSON format:

{
    "title": "Plumsail",
    "id": 1,
    "customFields": {}
}

Input Parameters

Parameter Description Example
$select An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. Region,IsPartner,ManagerContact/Email
$expand An ODATA $expand query option to specify that the request returns the values of lookups. ManagerContact
$filter An ODATA $filter query option to restrict the entries returned Region eq 'Asia'
$orderBy An ODATA $orderBy query option for specifying the order of entries. ID desc
$top An ODATA $top query option to select the first n items of the return set for return (default = 50, maximum = 100). 100
$skiptoken An ODATA $skiptoken query option to skip over items until the specified item is reached and return the rest. Paged=TRUE&p_ID=100

Example

Get organizations example

Create an organization

Creates new organization and returns it.

Output Parameters

Parameter Description Example
Organization Created organization

Example of Organization in JSON format:

{
    "title": "Plumsail",
    "id": 1,
    "customFields": {}
}

Input Parameters

Parameter Description Example
Organization Title Title of the organization Plumsail
Organization Custom Fields JSON object with custom field values to be set.
{
    "Location": "USA",
    "PhoneNumber": "(123)123-1234"
}

Example

Create organization example

Delete an organization

Deletes an organization by ID.

Input Parameters

Parameter Description Example
id Organization ID 15

Example

Delete organization by id example

Get a single organization

Gets the organization by ID and returns it.

Output Parameters

Parameter Description Example
Organization Found organization

Example of Organization in JSON format:

{
    "title": "Plumsail",
    "id": 1,
    "customFields": {}
}

Input Parameters

Parameter Description Example
id Organization ID 15
$select An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. Region,IsPartner,ManagerContact/Email
$expand An ODATA $expand query option to specify that the request returns the values of lookups. ManagerContact

Example

Get organization by ID example

Update an organization

Updates an organization and returns it.

Output Parameters

Parameter Description Example
Organization Updated organization

Example of Organization in JSON format:

{
    "title": "Plumsail",
    "id": 1,
    "customFields": {}
}

Input Parameters

Parameter Description Example
id Organization ID 15
Organization Title Title of the organization New tree inc.
Organization Custom Fields JSON object with custom field values to be set.
{
    "Location": "USA",
    "PhoneNumber": "(123)123-1234"
}

Example

Update organization by id example

Delete an organization by title

Deletes an organization by title.

Input Parameters

Parameter Description Example
title Organization Title New tree inc.

Example

Delete organization by title example

Get a single organization by title

Gets the organization by Title and returns it.

Output Parameters

Parameter Description Example
Organization Found organization

Example of Organization in JSON format:

{
    "title": "Plumsail",
    "id": 1,
    "customFields": {}
}

Input Parameters

Parameter Description Example
title Organization Title New tree inc.
$select An ODATA $select query option to specify which fields to return for a list item. You can use * to return all available fields. Region,IsPartner,ManagerContact/Email
$expand An ODATA $expand query option to specify that the request returns the values of lookups. ManagerContact

Example

Get organization by Title example

Update an organization by title

Updates an organization and returns it.

Output Parameters

Parameter Description Example
Organization Updated organization

Example of Organization in JSON format:

{
    "title": "Plumsail",
    "id": 1,
    "customFields": {}
}

Input Parameters

Parameter Description Example
Organization Title Title of the organization New tree inc.
Organization Custom Fields JSON object with custom field values to be set.
{
    "Location": "USA",
    "PhoneNumber": "(123)123-1234"
}

Example

Update organization by title example