Contents

PowerApps
Connectors
Reference

Draft 2017-04-25
1|Page
 Contents

Contents
Contents ....................................................................................................................................... 2
PowerApps Service Functions Connectors ................................................................................... 6
10to8 Appointment Scheduling.................................................................................................... 7
Act! ............................................................................................................................................. 21
appFigures .................................................................................................................................. 29
Approvals .................................................................................................................................... 40
Asana .......................................................................................................................................... 44
Azure Automation ...................................................................................................................... 77
Azure Data Lake ........................................................................................................................ 102
Azure DocumentDB .................................................................................................................. 115
Azure Queues ........................................................................................................................... 157
Azure Resource Manager ......................................................................................................... 167
Basecamp 2............................................................................................................................... 270
Basecamp 3............................................................................................................................... 292
Bitbucket................................................................................................................................... 338
Bitly ........................................................................................................................................... 378
Blogger ...................................................................................................................................... 382
bttn ........................................................................................................................................... 399
Buffer ........................................................................................................................................ 410
Campfire ................................................................................................................................... 426
Capsule CRM ............................................................................................................................. 440
Chatter ...................................................................................................................................... 508
Computer Vision API ................................................................................................................. 534
Disqus ....................................................................................................................................... 563
DocuSign ................................................................................................................................... 583
Easy Redmine............................................................................................................................ 614
Eventbrite ................................................................................................................................. 648
Face API .................................................................................................................................... 681
Facebook................................................................................................................................... 728
Flic ............................................................................................................................................. 772
FreshBooks ............................................................................................................................... 780

2|Page
 Contents

Freshdesk .................................................................................................................................. 811

GitHub....................................................................................................................................... 833
Gmail ......................................................................................................................................... 838
Google Calendar ....................................................................................................................... 852
Google Contacts ....................................................................................................................... 870
Google Tasks ............................................................................................................................. 885
GoToMeeting ............................................................................................................................ 898
GoToTraining ............................................................................................................................ 912
GoToWebinar ........................................................................................................................... 924
Harvest...................................................................................................................................... 939
HelloSign ................................................................................................................................... 975
HipChat ..................................................................................................................................... 987
Infusionsoft ............................................................................................................................. 1000
Inoreader ................................................................................................................................ 1012
Insightly .................................................................................................................................. 1031
Instagram ................................................................................................................................ 1083
Instapaper ............................................................................................................................... 1132
Intercom ................................................................................................................................. 1161
JIRA ......................................................................................................................................... 1187
LeanKit .................................................................................................................................... 1224
LiveChat .................................................................................................................................. 1249
Logic flows .............................................................................................................................. 1275
LUIS ......................................................................................................................................... 1305
MailChimp .............................................................................................................................. 1319
Mandrill .................................................................................................................................. 1381
Medium .................................................................................................................................. 1408
Microsoft Translator ............................................................................................................... 1419
MSN Weather ......................................................................................................................... 1425
Muhimbi PDF .......................................................................................................................... 1444
Nexmo..................................................................................................................................... 1504
Notifications ........................................................................................................................... 1526
Office 365 Outlook ................................................................................................................. 1531
Office 365 Users ..................................................................................................................... 1638

3|Page
 Contents

Office 365 Video ..................................................................................................................... 1644

OneNote (Business) ................................................................................................................ 1653
Outlook Customer Manager ................................................................................................... 1671
Outlook Tasks ......................................................................................................................... 1688
Outlook.com ........................................................................................................................... 1711
PagerDuty ............................................................................................................................... 1818
Pinterest ................................................................................................................................. 1867
Pipedrive ................................................................................................................................. 1884
Pivotal Tracker ........................................................................................................................ 1912
Power BI.................................................................................................................................. 1925
PowerApps Notification.......................................................................................................... 1938
Powerflows ............................................................................................................................. 1941
Project Online ......................................................................................................................... 1971
Redmine.................................................................................................................................. 2002
RSS .......................................................................................................................................... 2037
SendGrid ................................................................................................................................. 2042
Service Bus .............................................................................................................................. 2058
Slack ........................................................................................................................................ 2100
Smartsheet ............................................................................................................................. 2106
SMTP ....................................................................................................................................... 2150
SparkPost ................................................................................................................................ 2157
Stripe....................................................................................................................................... 2179
SurveyMonkey ........................................................................................................................ 2204
Text Analytics.......................................................................................................................... 2225
Todoist .................................................................................................................................... 2235
Toodledo ................................................................................................................................. 2265
Trello ....................................................................................................................................... 2274
Twilio ...................................................................................................................................... 2351
Twitter .................................................................................................................................... 2379
Typeform ................................................................................................................................ 2400
Vimeo...................................................................................................................................... 2406
Visual Studio Team Services ................................................................................................... 2415
WebMerge .............................................................................................................................. 2479

4|Page
 Contents

WordPress .............................................................................................................................. 2494

Wunderlist .............................................................................................................................. 2520
Yammer .................................................................................................................................. 2564
YouTube .................................................................................................................................. 2588
PowerApps Tabular Data Source Connectors ........................................................................ 2597
Common Data Service ............................................................................................................ 2598
DB2 ......................................................................................................................................... 2599
Dynamics 365 ......................................................................................................................... 2600
Dynamics 365 for Financials ................................................................................................... 2601
Dynamics 365 for Operations ................................................................................................. 2602
Dynamics NAV ........................................................................................................................ 2603
Excel ........................................................................................................................................ 2604
Google Sheets ......................................................................................................................... 2605
Informix .................................................................................................................................. 2606
Oracle Database ..................................................................................................................... 2607
Salesforce ............................................................................................................................... 2608
SharePoint .............................................................................................................................. 2609
SQL Server............................................................................................................................... 2610
UserVoice................................................................................................................................ 2611
Zendesk ................................................................................................................................... 2612
PowerApps Blob Connectors .................................................................................................. 2613
Azure Blob Storage ................................................................................................................. 2614
Box .......................................................................................................................................... 2615
Dropbox .................................................................................................................................. 2616
File System .............................................................................................................................. 2617
FTP .......................................................................................................................................... 2618
Google Drive ........................................................................................................................... 2619
OneDrive ................................................................................................................................. 2620
OneDrive for Business ............................................................................................................ 2621
SFTP ........................................................................................................................................ 2622

5|Page
 PowerApps Service Functions Connectors

PowerApps Service Functions Connectors

These connectors provide a set of functions that can be used in PowerApps in the
same way that you use any of the built-in formulas included in PowerApps and extend
the capabilities of your applications.

6|Page
 10to8 Appointment Scheduling

10to8 Appointment Scheduling

10to8 is a powerful appointment management, communications & online
booking system.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
GetOrganisations () Get organisations
BookAppointment (string Book new appointment
organisation-id,
BookAppointmentParameterBody
body)

Triggers:
Name Summary
GetAppointments (string organisation-id) When a booking is made
GetCustomers (string organisation-id) When a new customer is added
GetInboxIncomingMessagesAppeared (string When an incoming message
organisation-id) appears in your inbox
GetInboxIncomingMessagesDisappeared (string When an incoming message
organisation-id) disappears from your inbox
GetInboxBookingRequestAppeared (string When a booking request
organisation-id) appears in your inbox
GetInboxBookingRequestDisappeared (string When a booking request
organisation-id) disappears from your inbox
GetInboxChangeCancellationRequestAppeared When a change or cancellation
(string organisation-id) request appears in your inbox

7|Page
 10to8 Appointment Scheduling

GetInboxChangeCancellationRequestDisappeared When a change or cancellation

(string organisation-id) request disappears from your
inbox

Objects:
Name Summary
BookAppointmentParameterBody
EventProposal
GetAppointmentsResponseItem
GetCustomersResponseItem
GetOrganisationsResponseItem
IncomingMessage

Actions:
GetOrganisations
Summary: Get organisations
Description: Returns a list of all organisations for the authorized account.

Syntax:
10to8AppointmentScheduling.GetOrganisations ()

Returns:
Type:array of (GetOrganisationsResponseItem)

BookAppointment
Summary: Book new appointment
Description: Book a new appointment in 10to8.

8|Page
 10to8 Appointment Scheduling

Syntax:
10to8AppointmentScheduling.BookAppointment (string organisation-
id, BookAppointmentParameterBody body)

Parameters:
Name Type Summary Require Related Action
d
organisatio string Pick your True GetOrganisatio
n-id (Organisation Id) organisatio ns
n.
body BookAppointmentParameter Details for True
Body a new
appointme
nt

Returns:
Type:string

Triggers:
Trigger GetAppointments
Summary: When a booking is made
Description: Triggers when a new booking is made in 10to8.

Syntax:
10to8AppointmentScheduling.GetAppointments (string organisation-
id)

Parameters:
Name Type Summary Required Related Action

9|Page
 10to8 Appointment Scheduling

organisation-id string Pick your True GetOrganisations

(Organisation organisation.
Id)

Returns:
Type:array of (GetAppointmentsResponseItem)

Trigger GetCustomers
Summary: When a new customer is added
Description: Triggers when a new customer is added in 10to8.

Syntax:
10to8AppointmentScheduling.GetCustomers (string organisation-id)

Parameters:
Name Type Summary Required Related Action
organisation-id string Pick your True GetOrganisations
(Organisation organisation.
Id)

Returns:
Type:array of (GetCustomersResponseItem)

Trigger GetInboxIncomingMessagesAppeared
Summary: When an incoming message appears in your inbox
Description: Triggers when an incoming message appears in your inbox.

Syntax:

10 | P a g e
 10to8 Appointment Scheduling

10to8AppointmentScheduling.GetInboxIncomingMessagesAppeared
(string organisation-id)

Parameters:
Name Type Summary Required Related Action
organisation-id string Pick your True GetOrganisations
(Organisation organisation.
Id)

Returns:
Type:array of (IncomingMessage)

Trigger GetInboxIncomingMessagesDisappeared
Summary: When an incoming message disappears from your inbox
Description: Triggers when an incoming message disappears from your inbox.

Syntax:
10to8AppointmentScheduling.GetInboxIncomingMessagesDisappeared
(string organisation-id)

Parameters:
Name Type Summary Required Related Action
organisation-id string Pick your True GetOrganisations
(Organisation organisation.
Id)

Returns:
Type:array of (IncomingMessage)

11 | P a g e
 10to8 Appointment Scheduling

Trigger GetInboxBookingRequestAppeared
Summary: When a booking request appears in your inbox
Description: Triggers when a booking request appears in your inbox.

Syntax:
10to8AppointmentScheduling.GetInboxBookingRequestAppeared
(string organisation-id)

Parameters:
Name Type Summary Required Related Action
organisation-id string Pick your True GetOrganisations
(Organisation organisation.
Id)

Returns:
Type:array of (EventProposal)

Trigger GetInboxBookingRequestDisappeared
Summary: When a booking request disappears from your inbox
Description: Triggers when a booking request disappears from your inbox.

Syntax:
10to8AppointmentScheduling.GetInboxBookingRequestDisappeared
(string organisation-id)

Parameters:
Name Type Summary Required Related Action
organisation-id string Pick your True GetOrganisations
organisation.

12 | P a g e
 10to8 Appointment Scheduling

(Organisation
Id)

Returns:
Type:array of (EventProposal)

Trigger GetInboxChangeCancellationRequestAppeared
Summary: When a change or cancellation request appears in your inbox
Description: Triggers when a change or cancellation request appears in your inbox.

Syntax:
10to8AppointmentScheduling.GetInboxChangeCancellationRequestAppe
ared (string organisation-id)

Parameters:
Name Type Summary Required Related Action
organisation-id string Pick your True GetOrganisations
(Organisation organisation.
Id)

Returns:
Type:array of (EventProposal)

Trigger GetInboxChangeCancellationRequestDisappeared
Summary: When a change or cancellation request disappears from your inbox
Description: Triggers when a change or cancellation request disappears from your
inbox.

Syntax:

13 | P a g e
 10to8 Appointment Scheduling

10to8AppointmentScheduling.GetInboxChangeCancellationRequestDisa
ppeared (string organisation-id)

Parameters:
Name Type Summary Required Related Action
organisation-id string Pick your True GetOrganisations
(Organisation organisation.
Id)

Returns:
Type:array of (EventProposal)

14 | P a g e
 10to8 Appointment Scheduling

BookAppointmentParameterBody
Summary:
Description: Details for a new appointment

Properties:
Name Type Summary
start string(date-time) (UTC format) yyyy-MM-
Start Date-Time ddTHH:mm:ss.fffZ
end string(date-time) (UTC format) yyyy-MM-
End Date-Time ddTHH:mm:ss.fffZ
title string Appointment name.
Name
description string Appointment description.
Description

15 | P a g e
 10to8 Appointment Scheduling

EventProposal
Summary:
Description: A booking, change or cancellation request for a booking from a customer

Properties:
Name Type Summary
from_name string The name of the customer
Customer Name who made the request.
from_contact string The phone number or
Email Address or Phone email address of the
Number customer who made the
request.
appointment_name string The name of the
Appointment Name appointment.
appointment_start string(date-time) yyyy-MM-
Appointment Start Date- ddTHH:mm:ss.fffZ
Time
received string(date-time) yyyy-MM-
Request Received Date- ddTHH:mm:ss.fffZ
Time
type string Booking, rebooking or
Type of Request cancellation.
id string The unique identifier of
Request ID Number the request in 10to8.

16 | P a g e
 10to8 Appointment Scheduling

GetAppointmentsResponseItem
Summary:
Description: A booked appointment, possibly with a customer

Properties:
Name Type Summary
start string(date-time) yyyy-MM-
Start Date-Time ddTHH:mm:ss.fffZ
end string(date-time) yyyy-MM-
End Date-Time ddTHH:mm:ss.fffZ
name string The name or type of the
Name of Appointment appointment.
customers_name string The full name of the
Customer's Name customer.
customers_email string The email address of the
Customer's Email Address customer.
customers_number string The phone number of the
Customer's Phone customer.
Number
id integer The unique identifier of
Appointment ID number the appointment in 10to8.

17 | P a g e
 10to8 Appointment Scheduling

GetCustomersResponseItem
Summary:
Description: Details of a customer

Properties:
Name Type Summary
name string The description of the
Description appointment.
email string The contact email address
Customer's Email Address of the customer.
mobile_number string The contact mobile phone
Customer's Mobile number of the customer.
Number
id integer The unique identifier of
Customer ID Number the customer in 10to8.

18 | P a g e
 10to8 Appointment Scheduling

GetOrganisationsResponseItem
Summary:
Description:

Properties:
Name Type Summary
name string

id integer

19 | P a g e
 10to8 Appointment Scheduling

IncomingMessage
Summary:
Description: An incoming message from a customer, either by email or SMS.

Properties:
Name Type Summary
from_name string The name of the customer
Customer Name who sent the message.
from_contact string The phone number or
Phone Number or Email email address that the
Address message was sent from.
content string The Content of the
Message Content Message.
received string(date-time) yyyy-MM-
Received at Date-Time ddTHH:mm:ss.fffZ
id string The unique identifier of the
Message ID message in 10to8.

20 | P a g e
 Act!

Act!
Act! helps individuals, small businesses, and sales teams organize prospect
and customer details in one place.

Status: Preview Tier: Standard Version: v1

Actions:
Name Summary
ListContacts ([Optional]string Get all contacts
$filter)
CreateContact Create a contact
(act.web.api.models.Contact.noID
contact)
GetContact (string contactid) Get a contact

Triggers:
Name Summary
TrigNewContact () When there is a new contact

Objects:
Name Summary
act.web.api.models.Contact
act.web.api.models.Contact.noID

Actions:
ListContacts
Summary: Get all contacts
Description: Get a list of all contacts.
21 | P a g e
 Act!

Syntax:
Act!.ListContacts ([Optional]string $filter)

Parameters:
Name Type Summary Required Related
Action
$filter string OData compliant False
(Filter $filter query i.e.
Query) (recordOwner eq
'John Smith')

Returns:
Type:array of (act.web.api.models.Contact)

CreateContact
Summary: Create a contact
Description: Create a new contact.

Syntax:
Act!.CreateContact (act.web.api.models.Contact.noID contact)

Parameters:
Name Type Summary Required Related
Action
contact act.web.api.models.Contact.noID True

Returns:

22 | P a g e
 Act!

Type:act.web.api.models.Contact

GetContact
Summary: Get a contact
Description: Get details of a specific contact.

Syntax:
Act!.GetContact (string contactid)

Parameters:
Name Type Summary Required Related
Action
contactid string Select a contact True ListContacts
(Contact
Id)

Returns:
Type:act.web.api.models.Contact

Triggers:
Trigger TrigNewContact
Summary: When there is a new contact
Description: Triggers when there is a new contact (up to 100 contacts).

Syntax:
Act!.TrigNewContact ()

Returns:
Type:array of (act.web.api.models.Contact)
23 | P a g e
 Act!

24 | P a g e
 Act!

act.web.api.models.Contact
Summary:
Description:

Properties:
Name Type Summary
id string The id of the contact.
Id
fullName string The full name (first and
Full Name last) of the contact.
emailAddress string The email address of the
Email Address contact.
company string The name of the
Company company.
idStatus string The id status of the
Id Status contact.
referredBy string The person who referred
Referred By the contact.
jobTitle string The job title of the
Job Title contact.
businessPhone string The business phone
Business Phone Number number (with area code).
mobilePhone string The mobile phone
Mobile Phone Number number (with area code).
customFields CustomFields Key-value pairs
Custom Fields representing the custom
fields for this contact
(where key is the field

25 | P a g e
 Act!

name, and value is the

field value).

CustomFields
Summary: Custom Fields
Description: Key-value pairs representing the custom fields for this contact (where key
is the field name, and value is the field value).

Properties:
Name Type Summary

26 | P a g e
 Act!

act.web.api.models.Contact.noID
Summary:
Description:

Properties:
Name Type Summary
fullName string The full name (first and
Full Name last) of the contact.
emailAddress string The email address of the
Email Address contact.
company string The name of the
Company company.
idStatus string The id status of the
Id Status contact.
referredBy string The person who referred
Referred By the contact.
jobTitle string The job title of the
Job Title contact.
businessPhone string The business phone
Business Phone Number number (with area code).
mobilePhone string The mobile phone
Mobile Phone Number number (with area code).
customFields CustomFields Key-value pairs
Custom Fields representing the custom
fields for this contact
(where key is the field
name, and value is the
field value).

27 | P a g e
 Act!

CustomFields
Summary: Custom Fields
Description: Key-value pairs representing the custom fields for this contact (where key
is the field name, and value is the field value).

Properties:
Name Type Summary

28 | P a g e
 appFigures

appFigures
appFigures is a reporting platform for mobile app developers. It brings
together all of your app store sales, ad data, worldwide reviews, and hourly
rank updates based off of the available reports from your synced accounts.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
GetMyProducts () Get My Products
SearchRatings Get ratings snapshots
([Optional]string products)
SearchReviews Get reviews
([Optional]string products)
SearchEvents () Get events

Triggers:
Name Summary
OnNewEvent () When an event occurs
OnNewReview When there is a new review
([Optional]string products)
OnNewRating When an app is rated
([Optional]string products)

Objects:
Name Summary
Event

29 | P a g e
 appFigures

MyProduct
MyProductsResponse
Rating
Review

Actions:
GetMyProducts
Summary: Get My Products
Description: Returns my products

Syntax:
appFigures.GetMyProducts ()

Returns:
Type:MyProductsResponse
Description: Stores tracked by appFigures

SearchRatings
Summary: Get ratings snapshots
Description: Get an app's ratings snapshot for a given region and date with a few
filters

Syntax:
appFigures.SearchRatings ([Optional]string products)

Parameters:
Name Type Summary Required Related Action

30 | P a g e
 appFigures

products string One of your False GetMyProducts

(Product Products in
Id) appFigures

Returns:
Type:array of (Rating)

SearchReviews
Summary: Get reviews
Description: Get an app's reviews with a variety of filters, as well as review count
breakdowns

Syntax:
appFigures.SearchReviews ([Optional]string products)

Parameters:
Name Type Summary Required Related Action
products string One of your False GetMyProducts
(Product Products in
Id) appFigures

Returns:
Type:array of (Review)

SearchEvents
Summary: Get events
Description: Get the events for this account's apps

Syntax:

31 | P a g e
 appFigures

appFigures.SearchEvents ()

Returns:
Type:array of (Event)

Triggers:
Trigger OnNewEvent
Summary: When an event occurs
Description: Trigger an action on an event for this account's apps

Syntax:
appFigures.OnNewEvent ()

Returns:
Type:array of (Event)

Trigger OnNewReview
Summary: When there is a new review
Description: Fire an action when there is a new review

Syntax:
appFigures.OnNewReview ([Optional]string products)

Parameters:
Name Type Summary Required Related Action
products string One of your False GetMyProducts
(Product Products in
Id) appFigures

32 | P a g e
 appFigures

Returns:
Type:array of (Review)

Trigger OnNewRating
Summary: When an app is rated
Description: Fire an action when an app is rated

Syntax:
appFigures.OnNewRating ([Optional]string products)

Parameters:
Name Type Summary Required Related Action
products string One of your False GetMyProducts
(Product Products in
Id) appFigures

Returns:
Type:array of (Rating)

33 | P a g e
 appFigures

Event
Summary:
Description: Event data for a product tracked by appFigures

Properties:
Name Type Summary
id string The Id of the event
Event Id
caption string The caption of the event
Caption
date string(date-time) The date for the event
Date
origin string The origin of the event
Origin
details string The details of the event
Details
products array of (string) The products relevant to
Products the event

34 | P a g e
 appFigures

MyProduct
Summary:
Description: A Product belonging to my account

Properties:
Name Type Summary
id string Id of your product
Product Id
name string Name of your product
Product Name
developer string Developer of your product
Developer
store string The store this product
Store belongs to
release_date string(date-time) Release date of your
Release Date product
updated_date string(date-time) Updated date of your
Updated Date product
version string Version of your product
Version

35 | P a g e
 appFigures

MyProductsResponse
Summary:
Description: Stores tracked by appFigures

Properties:
Name Type Summary
products array of (MyProduct) Collection Of Products
Products

36 | P a g e
 appFigures

Rating
Summary:
Description: Rating data for a product tracked by appFigures

Properties:
Name Type Summary
product string The Id of the product this
Product Id rating is for
region string The country or language
Region for this rating snapshot
date string(date-time) The date for this rating
Date snapshot
oneStar integer(int32) The number of one-star
One Star Reviews reviews for the product at
the time of the snampshot
twoStar integer(int32) The number of two-star
Two Star Reviews reviews for the product at
the time of the snampshot
threeStar integer(int32) The number of three-star
Three Star Reviews reviews for the product at
the time of the snampshot
fourStar integer(int32) The number of four-star
Four Star Reviews reviews for the product at
the time of the snampshot
fiveStar integer(int32) The number of five-star
Five Star Reviews reviews for the product at
the time of the snampshot

37 | P a g e
 appFigures

Review
Summary:
Description: A review of an app tracked by appFigures

Properties:
Name Type Summary
author string The name of the author
Author that left this review
title string The title of the review; if
Title a translation language has
been provided this will
hold the translated title
review string The full review
Review
original_title string If a translation language
Original Title has been provided this
will hold the original title
before translation
original_review string If a translation language
Original Review has been provided this
will hold the original
review before translation
stars integer(int32) Number of stars the
Stars author left for the app.
iso string The country code where
Country Code this review was observed.
version string The version of the app
Version this review is for (Note:

38 | P a g e
 appFigures

not all app stores support

app version in reviews)
date string(date-time) Date the review was left
Date on the store
product string The ID of the product this
Product Id review belongs to
id string A unique ID for this
Review Id review

39 | P a g e
 Approvals

Approvals
Enables approvals in workflows.

Status: Tier: Standard Version: 1.0

Actions:
Name Summary
approvalSubscribe Start an approval
([internal]ApprovalSubscriptionRequest
ApprovalSubscriptionRequest)
approvalUnsubscribe (string Unsubscribes approval
subscriptionid)

Triggers:
Name Summary

Objects:
Name Summary
ApprovalSubscriptionRequest

Actions:
approvalSubscribe
Summary: Start an approval
Description: Start an approval

Syntax:

40 | P a g e
 Approvals

Approvals.approvalSubscribe
([internal]ApprovalSubscriptionRequest
ApprovalSubscriptionRequest)

Parameters:
Name Type Summary Require Relate
d d
Action
ApprovalSubscriptionReq ApprovalSubscriptionReq Model for True
uest uest approval
subscripti
on

Returns:

approvalUnsubscribe
Summary: Unsubscribes approval
Description: Unsubscribes approval

Syntax:
Approvals.approvalUnsubscribe (string subscriptionid)

Parameters:
Name Type Summary Required Related
Action
subscriptionid string Id of subscription True
(Id of to be deleted
subscription

41 | P a g e
 Approvals

to be
deleted)

Returns:

42 | P a g e
 Approvals

ApprovalSubscriptionRequest
Summary:
Description: Model for approval subscription

Properties:
Name Type Summary
NotificationUrl string Gets or sets callback url
to flow engine. It is
expected as part of the
webhook request
title string Specify the title of the
Title approval
details string Specify the details of the
Details approval request
itemLink string Specify a link to the item
Item Link to approve
itemLinkDescription string Specify a description for
Item Link Description the item to approve
assignedTo string Specify to whom the
Assigned To approval should be
assigned

43 | P a g e
 Asana

Asana
Asana enables teams to manage their projects and tasks in one place.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
ListWorkspaces () List workspaces
ListProjects (string List projects from workspace
workspace)
CreateProject (string Create new project
workspace, ProjectRequest
project)
GetProject (string project_id) Get project by ID
ListTasks (string workspace, List tasks from project
string project)
CreateTask (string workspace, Create Task
string projects, TaskRequest
task)
GetTask (string task_id) Get task by ID
CompleteTask (string task_id) Complete Task
AddComment (string task_id, Add Comment
AddCommentParameterBody
body)
ListUsers (string List users by workspace
workspace_id)
GetUser (string user_id) Get user by ID

44 | P a g e
 Asana

Triggers:
Name Summary
OnProjectCreated (string When a project is created
workspace)
OnTaskCreated (string When a task is created
workspace, string project)
OnTaskCompleted (string When a task is completed
workspace, string project)

Objects:
Name Summary
AddCommentParameterBody
AddCommentResponse
Assignee Assignee
CreatedBy Author
CurrentStatus Status
ListProjectsResponse
ListTasksResponse
ListUsersResponse
ListWorkSpacesResponse
Owner Owner
ProjectRequest
ProjectResponse
Target Task
TaskRequest
TaskResponse
UserResponse
WorkSpace Workspace

45 | P a g e
 Asana

Actions:
ListWorkspaces
Summary: List workspaces
Description: Lists workspaces for the current user.

Syntax:
Asana.ListWorkspaces ()

Returns:
Type:ListWorkSpacesResponse

ListProjects
Summary: List projects from workspace
Description: Lists projects for the current user.

Syntax:
Asana.ListProjects (string workspace)

Parameters:
Name Type Summary Required Related Action
workspace string Workspace to True ListWorkspaces
(Workspace monitor for
ID) new projects.

Returns:
Type:ListProjectsResponse

46 | P a g e
 Asana

CreateProject
Summary: Create new project
Description: Create a new project.

Syntax:
Asana.CreateProject (string workspace, ProjectRequest project)

Parameters:
Name Type Summary Required Related Action
workspace string Workspace to True ListWorkspaces
(Workspace use for new
ID) projects.
project ProjectRequest An Asana True
project used
to create new
projects.

Returns:
Type:ProjectResponse
Description: An Asana project.

GetProject
Summary: Get project by ID
Description: Retrieves project object by Project ID.

Syntax:
Asana.GetProject (string project_id)

Parameters:

47 | P a g e
 Asana

Name Type Summary Required Related

Action
project_id string True
(Project ID)

Returns:
Type:ProjectResponse
Description: An Asana project.

ListTasks
Summary: List tasks from project
Description: List tasks for a specified project.

Syntax:
Asana.ListTasks (string workspace, string project)

Parameters:
Name Type Summary Required Related Action
workspace string Workspace to True ListWorkspaces
(Workspace monitor for
ID) new projects.
project string Project True ListProjects
(Project)

Returns:
Type:ListTasksResponse

CreateTask
Summary: Create Task

48 | P a g e
 Asana

Description: Create a new task.

Syntax:
Asana.CreateTask (string workspace, string projects, TaskRequest
task)

Parameters:
Name Type Summary Required Related Action
workspace string Workspace to True ListWorkspaces
(Workspace use for your
ID) projects.
projects string Project True ListProjects
(Project ID)
task TaskRequest An Asana task True
used to create
new tasks.

Returns:
Type:TaskResponse
Description: An Asana task.

GetTask
Summary: Get task by ID
Description: Retrieves task object by Task ID.

Syntax:
Asana.GetTask (string task_id)

Parameters:

49 | P a g e
 Asana

Name Type Summary Required Related

Action
task_id string True
(Task ID)

Returns:
Type:TaskResponse
Description: An Asana task.

CompleteTask
Summary: Complete Task
Description: Mark an existing task as complete.

Syntax:
Asana.CompleteTask (string task_id)

Parameters:
Name Type Summary Required Related
Action
task_id string True
(Task ID)

Returns:
Type:TaskResponse
Description: An Asana task.

AddComment
Summary: Add Comment
Description: Add a comment to an existing task.

50 | P a g e
 Asana

Syntax:
Asana.AddComment (string task_id, AddCommentParameterBody body)

Parameters:
Name Type Summary Required Related
Action
task_id string True
(Task ID)
body AddCommentParameterBody True

Returns:
Type:AddCommentResponse
Description: A comment on an Asana task.

ListUsers
Summary: List users by workspace
Description: Retrieves the list of users for a given workspace.

Syntax:
Asana.ListUsers (string workspace_id)

Parameters:
Name Type Summary Required Related Action
workspace_id string Workspace to True ListWorkspaces
(Workspace monitor for
ID) users.

51 | P a g e
 Asana

Returns:
Type:ListUsersResponse

GetUser
Summary: Get user by ID
Description: Retrieves user object by User ID.

Syntax:
Asana.GetUser (string user_id)

Parameters:
Name Type Summary Required Related
Action
user_id string User True
(User)

Returns:
Type:UserResponse
Description: An Asana user.

Triggers:
Trigger OnProjectCreated
Summary: When a project is created
Description: Triggers when a new project is created.

Syntax:
Asana.OnProjectCreated (string workspace)

Parameters:
52 | P a g e
 Asana

Name Type Summary Required Related Action

workspace string Workspace to True ListWorkspaces
(Workspace monitor for
ID) new projects.

Returns:
Type:ListProjectsResponse

Trigger OnTaskCreated
Summary: When a task is created
Description: Triggers when a new task is created.

Syntax:
Asana.OnTaskCreated (string workspace, string project)

Parameters:
Name Type Summary Required Related Action
workspace string Workspace to True ListWorkspaces
(Workspace monitor for
ID) new projects.
project string Project True ListProjects
(Project ID)

Returns:
Type:ListTasksResponse

Trigger OnTaskCompleted
Summary: When a task is completed
Description: Triggers when an existing task is completed.

53 | P a g e
 Asana

Syntax:
Asana.OnTaskCompleted (string workspace, string project)

Parameters:
Name Type Summary Required Related Action
workspace string Workspace to True ListWorkspaces
(Workspace monitor for
ID) new projects.
project string Project True ListProjects
(Project ID)

Returns:
Type:ListTasksResponse

54 | P a g e
 Asana

AddCommentParameterBody
Summary:
Description:

Properties:
Name Type Summary
data Data

Data
Summary:
Description:

Properties:
Name Type Summary
text string Text to be used as
Comment comment.

55 | P a g e
 Asana

AddCommentResponse
Summary:
Description: A comment on an Asana task.

Properties:
Name Type Summary
data Data A comment on an Asana
task.

Data
Summary:
Description: A comment on an Asana task.

Properties:
Name Type Summary
target Target The task that this
Task comment is associated
with.
text string The text of the comment.
Text
created_at string The date and time at
Creation date which this comment was
created.
created_by CreatedBy The user that authored
Author this comment.
source string The component of the
Source Asana product the user
used to trigger the
comment.

56 | P a g e
 Asana

type string The type of comment this

Type is.
id string The ID for this comment.
Comment ID

57 | P a g e
 Asana

Assignee
Summary: Assignee
Description: The user to whom this task is assigned.

Properties:
Name Type Summary
id string
ID
name string
name

58 | P a g e
 Asana

CreatedBy
Summary: Author
Description: The user that authored this comment.

Properties:
Name Type Summary
id string The ID of the user that
ID authored this comment.
name string The name of the user that
name authored this comment.

59 | P a g e
 Asana

CurrentStatus
Summary: Status
Description:

Properties:
Name Type Summary
color string The color status of the
color project.
text string Text describing the project
text status.
author Author author.

Author
Summary:
Description: author.

Properties:
Name Type Summary
id string ID of the author of the
ID project status.
name string Name of the author of the
name project status.

60 | P a g e
 Asana

ListProjectsResponse
Summary:
Description:

Properties:
Name Type Summary
data array of (ProjectResponse)
Projects

61 | P a g e
 Asana

ListTasksResponse
Summary:
Description:

Properties:
Name Type Summary
data array of (TaskResponse)
Tasks

62 | P a g e
 Asana

ListUsersResponse
Summary:
Description:

Properties:
Name Type Summary
data array of (UserResponse)
Users

63 | P a g e
 Asana

ListWorkSpacesResponse
Summary:
Description:

Properties:
Name Type Summary
data array of (DataItem)

DataItem
Summary:
Description:

Properties:
Name Type Summary
id integer(int32)

name string

is_organization boolean

64 | P a g e
 Asana

Owner
Summary: Owner
Description: The project owner.

Properties:
Name Type Summary
id string The ID of the project
ID owner.
name string The name of the project
name owner.

65 | P a g e
 Asana

ProjectRequest
Summary:
Description: An Asana project used to create new projects.

Properties:
Name Type Summary
data Data An Asana project used to
create new projects.

Data
Summary:
Description: An Asana project used to create new projects.

Properties:
Name Type Summary
name string Name of the project.
Project name
due_date string(date) yyyy-MM-dd
Due date
public boolean True if the project is public
Public to the organization.
color string Color used to display the
Project color project. Values: [dark-
pink, dark-green, dark-
blue, dark-red, dark-teal,
dark-brown, dark-orange,
dark-purple, dark-warm-
gray, light-pink, light-
green, light-blue, light-red,

66 | P a g e
 Asana

light-teal, light-yellow,
light-orange, light-purple,
light-warm-gray]
notes string Notes about the project.
Project notes
owner string Owner of the project.
Owner
archived boolean Archived projects do not
Archive show in the UI by default.

67 | P a g e
 Asana

ProjectResponse
Summary:
Description: An Asana project.

Properties:
Name Type Summary
id string
Project ID
name string
Project name
notes string
Project notes
created_at string(date-time) yyyy-MM-
Created date ddTHH:mm:ss.fffZ
modified_at string(date-time) yyyy-MM-
Modified date ddTHH:mm:ss.fffZ
owner Owner The project owner.
Owner
due_date string(date) yyyy-MM-dd
Due date
current_status CurrentStatus
Status
public boolean
Public
archived boolean
Archived
workspace WorkSpace The workspace.
Workspace
color string Project color.

68 | P a g e
 Asana

Color

69 | P a g e
 Asana

Target
Summary: Task
Description: The task that this comment is associated with.

Properties:
Name Type Summary
id string The ID of the task that this
ID comment is associated
with.
name string The ID of the task that this
name comment is associated
with.

70 | P a g e
 Asana

TaskRequest
Summary:
Description: An Asana task used to create new tasks.

Properties:
Name Type Summary
data Data An Asana task used to
create new tasks.

Data
Summary:
Description: An Asana task used to create new tasks.

Properties:
Name Type Summary
name string Name of the task.
Task name
assignee string 'Email or User ID, defaults
Assignee to current user.
notes string Description of the task.
Description
assignee_status string Scheduling status of the
Assignee status task. Values: [Inbox,
Later, Today, Upcoming]
completed boolean Indicate if the task will be
Completed marked as completed.
due_on string(date) Due date of the task.
Due date

71 | P a g e
 Asana

72 | P a g e
 Asana

TaskResponse
Summary:
Description: An Asana task.

Properties:
Name Type Summary
id string
Task ID
created_at string(date-time) yyyy-MM-
Created date ddTHH:mm:ss.fffZ
modified_at string(date-time) yyyy-MM-
Modified date ddTHH:mm:ss.fffZ
name string
Task name
notes string
Task notes
completed boolean
Completed
assignee Assignee The user to whom this task
Assignee is assigned.
assignee_status string Scheduling status of the
Asignee status task.
completed_at string(date-time) yyyy-MM-
Completed date and time ddTHH:mm:ss.fffZ
due_on string(date) yyyy-MM-dd
Due date
due_at string yyyy-MM-
Due date and time ddTHH:mm:ss.fffZ
workspace WorkSpace The workspace.

73 | P a g e
 Asana

Workspace
num_hearts integer
Number of likes
hearted boolean
Liked

74 | P a g e
 Asana

UserResponse
Summary:
Description: An Asana user.

Properties:
Name Type Summary
id string
User ID
name string
User name
email string
Email

75 | P a g e
 Asana

WorkSpace
Summary: Workspace
Description: The workspace.

Properties:
Name Type Summary
id string
ID
name string
name

76 | P a g e
 Azure Automation

Azure Automation
Azure Automation provides tools to manage your cloud and on-premises
infrastructure seamlessly.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
Subscriptions_List List subscriptions
([internal][Optional]string x-
ms-api-version)
ResourceGroups_List List resource groups
([internal][Optional]string x-
ms-api-version, string
subscriptionId)
AutomationAccounts_List List Automation accounts
(string subscriptionId, string
resourceGroupName,
[internal][Optional]string x-
ms-api-version)
GetJobOutput (string Get job output
subscriptionId, string
resourceGroupName, string
automationAccount,
[internal][Optional]string x-
ms-api-version, string jobId)
GetStatusOfJob (string Get status of job
subscriptionId, string

77 | P a g e
 Azure Automation

resourceGroupName, string
automationAccount,
[internal][Optional]string x-
ms-api-version, string jobId)
WaitJob (string Wait for job
subscriptionId, string
resourceGroupName, string
automationAccount,
[internal][Optional]string x-
ms-api-version, string jobId)
Runbooks_List (string List runbooks
subscriptionId, string
resourceGroupName,
[internal][Optional]string x-
ms-api-version, string
automationAccount)
GetRunbook (string Get runbook
subscriptionId, string
resourceGroupName,
[internal][Optional]string x-
ms-api-version, string
automationAccount, string
runbookName)
CreateJob (string Create job
subscriptionId, string
resourceGroupName, string
automationAccount,
[internal][Optional]string x-
ms-api-version,

78 | P a g e
 Azure Automation

[Optional]string
runbookName,
CreateJobParameterBody
body, [Optional]boolean wait)

Triggers:
Name Summary

Objects:
Name Summary
AutomationAccountResponse
CreateJobParameterBody
CreateJobResponse
ResourceGroup
ResourceGroupListResult
RunbookListResults
Subscription
SubscriptionListResult

Actions:
Subscriptions_List
Summary: List subscriptions
Description: Gets a list of all the subscriptions to which the principal has access.

Syntax:
AzureAutomation.Subscriptions_List ([internal][Optional]string
x-ms-api-version)

79 | P a g e
 Azure Automation

Parameters:
Name Type Summary Required Related
Action
x-ms-api-version string False
(API
Version)

Returns:
Type:SubscriptionListResult
Description: Subscription list operation response.

ResourceGroups_List
Summary: List resource groups
Description: Lists all the resource groups within the subscription. Paginates at 1,000
records.

Syntax:
AzureAutomation.ResourceGroups_List ([internal][Optional]string
x-ms-api-version, string subscriptionId)

Parameters:
Name Type Summary Required Related Action
x-ms-api-version string False
(API Version)
subscriptionId string The unique True Subscriptions_List
(Subscription) identifier for
the Microsoft
Azure
subscription.

80 | P a g e
 Azure Automation

The
subscription
ID forms part
of the ID for
every Azure
resource.

Returns:
Type:ResourceGroupListResult
Description: List of resource groups.

AutomationAccounts_List
Summary: List Automation accounts
Description: Lists Azure Automation accounts in a resource group.

Syntax:
AzureAutomation.AutomationAccounts_List (string subscriptionId,
string resourceGroupName, [internal][Optional]string x-ms-api-
version)

Parameters:
Name Type Summary Require Related Action
d
subscriptionId string The unique True Subscriptions_List
(Subscription identifier
) for the
Microsoft
Azure
subscription

81 | P a g e
 Azure Automation

. The
subscription
ID forms
part of the
ID for every
Azure
resource.
resourceGroupNam string The name True ResourceGroups_Lis
e (Resource of the Azure t
Group) Resource
Group.
x-ms-api-version string False
(API Version)

Returns:
Type:AutomationAccountResponse

GetJobOutput
Summary: Get job output
Description: Get outputs of an Azure Automation job.

Syntax:
AzureAutomation.GetJobOutput (string subscriptionId, string
resourceGroupName, string automationAccount,
[internal][Optional]string x-ms-api-version, string jobId)

Parameters:
Name Type Summary Require Related Action
d

82 | P a g e
 Azure Automation

subscriptionId string The unique True Subscriptions_List

(Subscriptio identifier
n) for the
Microsoft
Azure
subscriptio
n. The
subscriptio
n ID forms
part of the
ID for every
Azure
resource.
resourceGroupNa string The name True ResourceGroups_List
me (Resource of the
Group) Azure
Resource
Group.
automationAccoun string The name True AutomationAccounts_L
t (Automation of the ist
Account) Azure
Automatio
n Account.
x-ms-api-version string False
(API
Version)
jobId string GUID for True
(Job ID) the ID of
the run.

83 | P a g e
 Azure Automation

Returns:
Type:string(binary)
Summary: Content
Description: Runbook content from the job

GetStatusOfJob
Summary: Get status of job
Description: Get Status of a Job

Syntax:
AzureAutomation.GetStatusOfJob (string subscriptionId, string
resourceGroupName, string automationAccount,
[internal][Optional]string x-ms-api-version, string jobId)

Parameters:
Name Type Summary Require Related Action
d
subscriptionId string The unique True Subscriptions_List
(Subscriptio identifier
n) for the
Microsoft
Azure
subscriptio
n. The
subscriptio
n ID forms
part of the
ID for every

84 | P a g e
 Azure Automation

Azure
resource.
resourceGroupNa string The name True ResourceGroups_List
me (Resource of the
Group) Azure
Resource
Group.
automationAccoun string The name True AutomationAccounts_L
t (Automation of the ist
Account) Azure
Automatio
n Account.
x-ms-api-version string False
(API
Version)
jobId string GUID for True
(Job ID) the ID of
the run.

Returns:
Type:CreateJobResponse

WaitJob
Summary: Wait for job
Description: Wait for a running job to complete.

Syntax:

85 | P a g e
 Azure Automation

AzureAutomation.WaitJob (string subscriptionId, string

resourceGroupName, string automationAccount,
[internal][Optional]string x-ms-api-version, string jobId)

Parameters:
Name Type Summary Require Related Action
d
subscriptionId string The unique True Subscriptions_List
(Subscriptio identifier
n) for the
Microsoft
Azure
subscriptio
n. The
subscriptio
n ID forms
part of the
ID for every
Azure
resource.
resourceGroupNa string The name True ResourceGroups_List
me (Resource of the
Group) Azure
Resource
Group.
automationAccoun string The name True AutomationAccounts_L
t (Automation of the ist
Account) Azure

86 | P a g e
 Azure Automation

Automatio
n Account.
x-ms-api-version string False
(API
Version)
jobId string GUID for True
(Job ID) the ID of
the run.

Returns:
Type:CreateJobResponse

Runbooks_List
Summary: List runbooks
Description: Lists Azure Automation runbooks in an automation account.

Syntax:
AzureAutomation.Runbooks_List (string subscriptionId, string
resourceGroupName, [internal][Optional]string x-ms-api-version,
string automationAccount)

Parameters:
Name Type Summary Require Related Action
d
subscriptionId string The unique True Subscriptions_List
(Subscriptio identifier
n) for the
Microsoft
Azure

87 | P a g e
 Azure Automation

subscriptio
n. The
subscriptio
n ID forms
part of the
ID for every
Azure
resource.
resourceGroupNa string The name True ResourceGroups_List
me (Resource of the
Group) Azure
Resource
Group.
x-ms-api-version string False
(API
Version)
automationAccoun string The name True AutomationAccounts_L
t (Automation of the ist
Account) Azure
Automatio
n Account.

Returns:
Type:RunbookListResults

GetRunbook
Summary: Get runbook
Description: Get information on an Azure Automation runbook.

88 | P a g e
 Azure Automation

Syntax:
AzureAutomation.GetRunbook (string subscriptionId, string
resourceGroupName, [internal][Optional]string x-ms-api-version,
string automationAccount, string runbookName)

Parameters:
Name Type Summary Require Related Action
d
subscriptionId string The unique True Subscriptions_List
(Subscriptio identifier
n) for the
Microsoft
Azure
subscriptio
n. The
subscriptio
n ID forms
part of the
ID for every
Azure
resource.
resourceGroupNa string The name True ResourceGroups_List
me (Resource of the
Group) Azure
Resource
Group.
x-ms-api-version string False
(API
Version)

89 | P a g e
 Azure Automation

automationAccoun string The name True AutomationAccounts_L

t (Automation of the ist
Account) Azure
Automatio
n Account.
runbookName string The name True
(Runbook of the
Name) Azure
Automatio
n runbook.

Returns:
Type:RunbookListResults

CreateJob
Summary: Create job
Description: Create Job to run on hybrid worker

Syntax:
AzureAutomation.CreateJob (string subscriptionId, string
resourceGroupName, string automationAccount,
[internal][Optional]string x-ms-api-version, [Optional]string
runbookName, CreateJobParameterBody body, [Optional]boolean
wait)

Parameters:
Name Type Summary Requir Related Action
ed
subscriptionId string The True Subscriptions_List
(Subscription) unique

90 | P a g e
 Azure Automation

identifier
for the
Microsoft
Azure
subscripti
on. The
subscripti
on ID
forms
part of
the ID for
every
Azure
resource.
resourceGroupN string The name True ResourceGroups_Lis
ame (Resource Group) of the t
Azure
Resource
Group.
automationAcco string The name True AutomationAccount
unt (Automation of the s_List
Account) Azure
Automati
on
Account.
x-ms-api-version string False
(API Version)
runbookName string Name of False Runbooks_List
(Runbook Name) the

91 | P a g e
 Azure Automation

runbook
to run.
body CreateJobParameter True
Body

wait boolean Wait for False

(Wait for Job) the job to
finish
before
completin
g the
action.

Returns:
Type:CreateJobResponse

92 | P a g e
 Azure Automation

AutomationAccountResponse
Summary:
Description:

Properties:
Name Type Summary
value array of (ValueItem) value

ValueItem
Summary:
Description:

Properties:
Name Type Summary
name string Name of the Azure
Automation account Name Automation account.

93 | P a g e
 Azure Automation

CreateJobParameterBody
Summary:
Description:

Properties:
Name Type Summary
properties Properties

Properties
Summary:
Description:

Properties:
Name Type Summary
parameters Parameters
Runbook Parameters
runOn string Worker group to run on.
Hybrid Automation
Worker Group

Parameters
Summary: Runbook Parameters
Description:

Properties:
Name Type Summary

94 | P a g e
 Azure Automation

CreateJobResponse
Summary:
Description:

Properties:
Name Type Summary
id string Resource ID of the Job
Resource ID
properties Properties properties

Properties
Summary:
Description: properties

Properties:
Name Type Summary
jobId string GUID for the Job ID.
Job ID
provisioningState string Provisioning state for the
Provisioning State job.
creationTime string(date-time) Creation time for the job.
Creation Time
endTime string(date-time) Time the job completed.
End Time
startTime string(date-time) Time the job started.
Start Time
status string Status of the job.
Status

95 | P a g e
 Azure Automation

statusDetails string Details on the status of

Status Details the job.

96 | P a g e
 Azure Automation

ResourceGroup
Summary:
Description: Resource group information.

Properties:
Name Type Summary
id string The ID of the resource group (e.g.
Id /subscriptions/XXX/resourceGroups/YYY).
name string The Name of the resource group.
Name
managedBy string Id of the resource that manages this
Managed By resource group.

97 | P a g e
 Azure Automation

ResourceGroupListResult
Summary:
Description: List of resource groups.

Properties:
Name Type Summary
value array of (ResourceGroup) The list of resource
groups.
nextLink string The URL to get the next
Next Link set of results.

98 | P a g e
 Azure Automation

RunbookListResults
Summary:
Description:

Properties:
Name Type Summary
value array of (ValueItem)

ValueItem
Summary:
Description:

Properties:
Name Type Summary
name string Name of the Automation
Runbook Name runbook.

99 | P a g e
 Azure Automation

Subscription
Summary:
Description: Subscription information.

Properties:
Name Type Summary
id string The fully qualified Id. For
Id example,
/subscriptions/00000000-
0000-0000-0000-
000000000000.
subscriptionId string The subscription Id.
Subscription Id
tenantId string The tenant Id.
Tenant Id
displayName string The subscription display
Display Name name.
state string The subscription state.
State Values: [Enabled, Warned,
PastDue, Disabled, Deleted]
authorizationSource string The authorization source of
Authorization Source the request. Valid values are
one or more combinations
of Legacy, RoleBased,
Bypassed, Direct and
Management. For example,
'Legacy, RoleBased'.

100 | P a g e
 Azure Automation

SubscriptionListResult
Summary:
Description: Subscription list operation response.

Properties:
Name Type Summary
value array of (Subscription) The subscriptions.

nextLink string The URL to get the next

Next Link set of results.

101 | P a g e
 Azure Data Lake

Azure Data Lake

Azure Data Lake Store connector allows you to read and add data to an Azure
Data Lake account.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
ListFiles (string account, List Files
[internal]string op,
[Optional]string path)
CreateFolder (string account, Create Folder
[internal]string op, string
path)
AppendFile_Concurrent Append File (concurrent)
(string account,
[internal]string op,
[advanced][Optional]string
appendMode, string filepath,
string body)
ReadFile (string account, Read File
[internal]string op,
[internal]string read, string
filepath)
UploadFile (string account, Upload File
[internal]string op,
[internal]string write, string
filepath,

102 | P a g e
 Azure Data Lake

[advanced][Optional]boolean
overwrite, string body)
AppendFile_Sequential (string Append File (sequential)
account, string filepath, string
body, [internal]string op,
[internal]string append,
[advanced][Optional]integer
offset)
DeleteFile (string account, Delete File
[internal]string op, string
filepath)

Triggers:
Name Summary
Trigger_ListFiles (string When a file is created or modified (metadata only)
account, [internal]string op,
[Optional]string path)

Objects:
Name Summary
folderResponse
operationPerformed
Trigger_ListFilesResponseItem

Actions:
ListFiles
Summary: List Files
Description: List files and folders in a Data Lake Store account.

103 | P a g e
 Azure Data Lake

Syntax:
AzureDataLake.ListFiles (string account, [internal]string op,
[Optional]string path)

Parameters:
Name Type Summary Required Related
Action
account string Account name True
(Account for Azure Data
name) Lake.
op string True

path string Path of the False

(Folder folder (no
path) leading '/').

Returns:
Type:folderResponse

CreateFolder
Summary: Create Folder
Description: Create a folder in a Data Lake Store account.

Syntax:
AzureDataLake.CreateFolder (string account, [internal]string op,
string path)

Parameters:

104 | P a g e
 Azure Data Lake

Name Type Summary Required Related

Action
account string Account name True
(Account for Azure Data
name) Lake.
op string True

path string Path of the True

(Folder folder to create
path) (no leading '/').

Returns:
Type:operationPerformed

AppendFile_Concurrent
Summary: Append File (concurrent)
Description: Concurrent append to a file.

Syntax:
AzureDataLake.AppendFile_Concurrent (string account,
[internal]string op, [advanced][Optional]string appendMode,
string filepath, string body)

Parameters:
Name Type Summary Required Related
Action
account string Account name True
(Account for Azure Data
name) Lake.

105 | P a g e
 Azure Data Lake

op string True

appendMode string Set to auto- False

(Append create if path
mode)Values: doesn't exist.
[autocreate, ]
filepath string Path of the file True
(File path) (no leading '/').
body string(binary) True

Returns:
Type:string
Summary: Operation message

ReadFile
Summary: Read File
Description: Read data from a Data Lake Store account.

Syntax:
AzureDataLake.ReadFile (string account, [internal]string op,
[internal]string read, string filepath)

Parameters:
Name Type Summary Required Related
Action
account string Account name True
(Account for Azure Data
name) Lake.

106 | P a g e
 Azure Data Lake

op string True

read string True

filepath string Path of the file True

(File path) (no leading '/').

Returns:
Type:string(binary)
Summary: File content

UploadFile
Summary: Upload File
Description: Upload data into a Data Lake Store account.

Syntax:
AzureDataLake.UploadFile (string account, [internal]string op,
[internal]string write, string filepath,
[advanced][Optional]boolean overwrite, string body)

Parameters:
Name Type Summary Required Related
Action
account string Account name True
(Account for Azure Data
name) Lake.
op string True

write string True

107 | P a g e
 Azure Data Lake

filepath string Path of the file True

(File path) (no leading '/').
overwrite boolean Overwrite if False
(Overwrite) existing file.
body string(binary) True

Returns:
Type:operationPerformed

AppendFile_Sequential
Summary: Append File (sequential)
Description: Append to a file serially.

Syntax:
AzureDataLake.AppendFile_Sequential (string account, string
filepath, string body, [internal]string op, [internal]string
append, [advanced][Optional]integer offset)

Parameters:
Name Type Summary Required Related
Action
account string Account name True
(Account for Azure Data
name) Lake.
filepath string Path of the file True
(File path) (no leading '/').
body string(binary) True

108 | P a g e
 Azure Data Lake

op string True
(Append
type)
append string True

offset integer(int64) The optional False

(Offset) offset in the
stream to begin
the append
operation.
Default is to
append at the
end of the
stream.

Returns:
Type:operationPerformed

DeleteFile
Summary: Delete File
Description: Delete a file from a Data Lake Store account.

Syntax:
AzureDataLake.DeleteFile (string account, [internal]string op,
string filepath)

Parameters:

109 | P a g e
 Azure Data Lake

Name Type Summary Required Related

Action
account string Account name True
(Account for Azure Data
name) Lake.
op string True

filepath string Path of the file True

(File path) (no leading '/').

Returns:
Type:operationPerformed

Triggers:
Trigger Trigger_ListFiles
Summary: When a file is created or modified (metadata only)
Description: Trigger whenever a new file is uploaded to a specific folder. Only returns
metadata of file and not content.

Syntax:
AzureDataLake.Trigger_ListFiles (string account,
[internal]string op, [Optional]string path)

Parameters:
Name Type Summary Required Related
Action
account string Account name True
(Account for Azure Data
name) Lake.

110 | P a g e
 Azure Data Lake

op string True

path string Path of the False

(Folder folder (no
path) leading '/').

Returns:
Type:array of (Trigger_ListFilesResponseItem)
Description: FileStatus

111 | P a g e
 Azure Data Lake

folderResponse
Summary:
Description:

Properties:
Name Type Summary
FileStatuses FileStatuses FileStatuses

FileStatuses
Summary:
Description: FileStatuses

Properties:
Name Type Summary
FileStatus array of FileStatus
(Trigger_ListFilesResponseItem)

112 | P a g e
 Azure Data Lake

operationPerformed
Summary:
Description:

Properties:
Name Type Summary
boolean boolean Flag if the last operation
Is Successful was successful.

113 | P a g e
 Azure Data Lake

Trigger_ListFilesResponseItem
Summary:
Description:

Properties:
Name Type Summary
pathSuffix string File or folder name.
File name
type string Type of item (directory or
Type file).
blockSize integer(int32) Block size of folder or file.
Block Size
accessTime integer(int32) Ticks since item last
Access Time accessed.
modificationTime integer(int32) Ticks since item last
Modification Time modified.

114 | P a g e
 Azure DocumentDB

Azure DocumentDB
Azure DocumentDB is a NoSQL service for highly available, globally distributed
app. Sign into your DocumentDB account to create, update, and query
documents and more.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
TestConnection () Test connection
GetDatabases () Get all databases
GetDatabase (string Get a database
databaseId)
GetCollections (string Get all collections
databaseId)
GetCollection (string Get a collection
databaseId, string
collectionId)
GetDocuments Get all documents
([advanced][Optional]string x-
ms-documentdb-partitionkey,
[advanced][Optional]number
x-ms-max-item-count,
[advanced][Optional]string x-
ms-continuation,
[advanced][Optional]string x-
ms-consistency-level,
[advanced][Optional]string x-

115 | P a g e
 Azure DocumentDB

ms-session-token,
[advanced][Optional]string x-
ms-activity-id, string
databaseId, string
collectionId)
CreateDocument Create or update document
([advanced][Optional]string x-
ms-documentdb-partitionkey,
[advanced][Optional]number
x-ms-max-item-count,
[advanced][Optional]string x-
ms-continuation,
[advanced][Optional]string x-
ms-consistency-level,
[advanced][Optional]string x-
ms-session-token,
[advanced][Optional]string x-
ms-activity-id,
[Optional]boolean x-ms-
documentdb-is-upsert, string
databaseId, string
collectionId,
postDocumentsRequest body)
QueryDocuments Query documents
([advanced][Optional]string x-
ms-documentdb-partitionkey,
[advanced][Optional]number
x-ms-max-item-count,
[advanced][Optional]string x-

116 | P a g e
 Azure DocumentDB

ms-continuation,
[advanced][Optional]boolean
x-ms-documentdb-query-
enablecrosspartition,
[advanced][Optional]string x-
ms-consistency-level,
[advanced][Optional]string x-
ms-session-token,
[advanced][Optional]string x-
ms-activity-id, string
databaseId, string
collectionId, queryRequest
body)
GetDocument Get a document
([advanced][Optional]string x-
ms-documentdb-partitionkey,
[advanced][Optional]number
x-ms-max-item-count,
[advanced][Optional]string x-
ms-continuation,
[advanced][Optional]string x-
ms-consistency-level,
[advanced][Optional]string x-
ms-session-token,
[advanced][Optional]string x-
ms-activity-id, string
databaseId, string
collectionId, string
documentId)

117 | P a g e
 Azure DocumentDB

ReplaceDocument Replace a document

([advanced][Optional]string x-
ms-documentdb-partitionkey,
[advanced][Optional]number
x-ms-max-item-count,
[advanced][Optional]string x-
ms-continuation,
[advanced][Optional]string x-
ms-consistency-level,
[advanced][Optional]string x-
ms-session-token,
[advanced][Optional]string x-
ms-activity-id, string
databaseId, string
collectionId, string
documentId,
putDocumentRequest body)
DeleteDocument Delete a document
([advanced][Optional]string x-
ms-documentdb-partitionkey,
[advanced][Optional]number
x-ms-max-item-count,
[advanced][Optional]string x-
ms-continuation,
[advanced][Optional]string x-
ms-consistency-level,
[advanced][Optional]string x-
ms-session-token,
[advanced][Optional]string x-

118 | P a g e
 Azure DocumentDB

ms-activity-id, string
databaseId, string
collectionId, string
documentId)

Triggers:
Name Summary

Objects:
Name Summary
getAccountResponse
GetCollectionResponseItem
getCollectionsResponse
getDatabaseResponse
getDatabasesResponse
getDocumentResponse
getDocumentsResponse
postDocumentsRequest
postDocumentsResponse
putDocumentRequest
putDocumentResponse
queryRequest
queryResponse

Actions:
TestConnection
Summary: Test connection
Description: Tests connection of the resource

119 | P a g e
 Azure DocumentDB

Syntax:
AzureDocumentDB.TestConnection ()

Returns:
Type:getAccountResponse

GetDatabases
Summary: Get all databases
Description: Get all databases

Syntax:
AzureDocumentDB.GetDatabases ()

Returns:
Type:getDatabasesResponse

GetDatabase
Summary: Get a database
Description: Get a database

Syntax:
AzureDocumentDB.GetDatabase (string databaseId)

Parameters:
Name Type Summary Required Related
Action

120 | P a g e
 Azure DocumentDB

databaseId string The name of True GetDatabases

(Database the database
ID)

Returns:
Type:getDatabaseResponse

GetCollections
Summary: Get all collections
Description: Get all collections

Syntax:
AzureDocumentDB.GetCollections (string databaseId)

Parameters:
Name Type Summary Required Related
Action
databaseId string The name of True GetDatabases
(Database the database
ID)

Returns:
Type:getCollectionsResponse

GetCollection
Summary: Get a collection
Description: Get a collection

Syntax:

121 | P a g e
 Azure DocumentDB

AzureDocumentDB.GetCollection (string databaseId, string

collectionId)

Parameters:
Name Type Summary Required Related
Action
databaseId string The name of True GetDatabases
(Database the database
ID)
collectionId string The name of True GetCollections
(Collection the collection
ID)

Returns:
Type:array of (GetCollectionResponseItem)

GetDocuments
Summary: Get all documents
Description: Get all documents

Syntax:
AzureDocumentDB.GetDocuments ([advanced][Optional]string x-ms-
documentdb-partitionkey, [advanced][Optional]number x-ms-max-
item-count, [advanced][Optional]string x-ms-continuation,
[advanced][Optional]string x-ms-consistency-level,
[advanced][Optional]string x-ms-session-token,
[advanced][Optional]string x-ms-activity-id, string databaseId,
string collectionId)

Parameters:

122 | P a g e
 Azure DocumentDB

Name Type Summary Required Related

Action
x-ms-documentdb- string The partition False
partitionkey (Partition key key value for
value) the requested
document or
attachment
operation.
x-ms-max-item-count number An integer False
(Max Item indicating the
Count) maximum
number of
items to be
returned per
page.
x-ms-continuation string A string token False
(Continuation returned for
Token) queries and
read-feed
operations if
there are more
results to be
read.
x-ms-consistency- string This is the False
level (Consistency consistency
Level)Values: level override.
[Strong, The valid
Bounded, values are:
Strong,

123 | P a g e
 Azure DocumentDB

Session, Bounded,
Eventual] Session, or
Eventual (in
order of
strongest to
weakest).
x-ms-session-token string A string token False
(Session used with
Token) session level
consistency.
x-ms-activity-id string A client False
(Activity id) supplied
identifier for
the operation,
which will be
echoed in the
server
response.
databaseId string The name of True GetDatabases
(Database ID) the database
collectionId string The name of True GetCollections
(Collection the collection
ID)

Returns:
Type:getDocumentsResponse

CreateDocument
Summary: Create or update document

124 | P a g e
 Azure DocumentDB

Description: Create or update document

Syntax:
AzureDocumentDB.CreateDocument ([advanced][Optional]string x-ms-
documentdb-partitionkey, [advanced][Optional]number x-ms-max-
item-count, [advanced][Optional]string x-ms-continuation,
[advanced][Optional]string x-ms-consistency-level,
[advanced][Optional]string x-ms-session-token,
[advanced][Optional]string x-ms-activity-id, [Optional]boolean
x-ms-documentdb-is-upsert, string databaseId, string
collectionId, postDocumentsRequest body)

Parameters:
Name Type Summary Required Related
Action
x-ms- string The False
documentdb- (Partition key value) partition key
partitionkey value for the
requested
document
or
attachment
operation.
x-ms-max- number An integer False
item-count (Max Item Count) indicating
the
maximum
number of
items to be

125 | P a g e
 Azure DocumentDB

returned per
page.
x-ms- string A string False
continuation (Continuation Token) token
returned for
queries and
read-feed
operations if
there are
more results
to be read.
x-ms- string This is the False
consistency- (Consistency consistency
level Level)Values: [Strong, level
Bounded, Session, override.
Eventual] The valid
values are:
Strong,
Bounded,
Session, or
Eventual (in
order of
strongest to
weakest).
x-ms-session- string A string False
token (Session Token) token used
with session
level
consistency.

126 | P a g e
 Azure DocumentDB

x-ms-activity- string A client False

id (Activity id) supplied
identifier for
the
operation,
which will
be echoed in
the server
response.
x-ms- boolean If set to False
documentdb- (IsUpsert) true, the
is-upsert document
will be
replaced if it
exists else
created.
databaseId string The name of True GetDatabases
(Database ID) the
database
collectionId string The name of True GetCollections
(Collection ID) the
collection
body postDocumentsRequest True

Returns:
Type:postDocumentsResponse

127 | P a g e
 Azure DocumentDB

QueryDocuments
Summary: Query documents
Description: Query documents

Syntax:
AzureDocumentDB.QueryDocuments ([advanced][Optional]string x-ms-
documentdb-partitionkey, [advanced][Optional]number x-ms-max-
item-count, [advanced][Optional]string x-ms-continuation,
[advanced][Optional]boolean x-ms-documentdb-query-
enablecrosspartition, [advanced][Optional]string x-ms-
consistency-level, [advanced][Optional]string x-ms-session-
token, [advanced][Optional]string x-ms-activity-id, string
databaseId, string collectionId, queryRequest body)

Parameters:
Name Type Summary Required Related
Action
x-ms-documentdb- string The partition False
partitionkey (Partition key key value for
value) the requested
document or
attachment
operation.
x-ms-max-item-count number An integer False
(Max Item indicating the
Count) maximum
number of
items to be
returned per
page.

128 | P a g e
 Azure DocumentDB

x-ms-continuation string A string token False

(Continuation returned for
Token) queries and
read-feed
operations if
there are
more results
to be read.
x-ms-documentdb- boolean If the False
query- (Enable Cross collection is
enablecrosspartition Partition) partitioned,
this must be
set to True to
allow
execution
across
multiple
partitions.
x-ms-consistency-level string This is the False
(Consistency consistency
Level)Values: level override.
[Strong, The valid
Bounded, values are:
Session, Strong,
Eventual] Bounded,
Session, or
Eventual (in
order of

129 | P a g e
 Azure DocumentDB

strongest to
weakest).
x-ms-session-token string A string token False
(Session used with
Token) session level
consistency.
x-ms-activity-id string A client False
(Activity id) supplied
identifier for
the operation,
which will be
echoed in the
server
response.
databaseId string The name of True GetDatabases
(Database ID) the database
collectionId string The name of True GetCollections
(Collection the collection
ID)
body queryRequest True

Returns:
Type:queryResponse

GetDocument
Summary: Get a document
Description: Get a document

130 | P a g e
 Azure DocumentDB

Syntax:
AzureDocumentDB.GetDocument ([advanced][Optional]string x-ms-
documentdb-partitionkey, [advanced][Optional]number x-ms-max-
item-count, [advanced][Optional]string x-ms-continuation,
[advanced][Optional]string x-ms-consistency-level,
[advanced][Optional]string x-ms-session-token,
[advanced][Optional]string x-ms-activity-id, string databaseId,
string collectionId, string documentId)

Parameters:
Name Type Summary Required Related
Action
x-ms-documentdb- string The partition False
partitionkey (Partition key key value for
value) the requested
document or
attachment
operation.
x-ms-max-item-count number An integer False
(Max Item indicating the
Count) maximum
number of
items to be
returned per
page.
x-ms-continuation string A string token False
(Continuation returned for
Token) queries and
read-feed
operations if

131 | P a g e
 Azure DocumentDB

there are more

results to be
read.
x-ms-consistency- string This is the False
level (Consistency consistency
Level)Values: level override.
[Strong, The valid
Bounded, values are:
Session, Strong,
Eventual] Bounded,
Session, or
Eventual (in
order of
strongest to
weakest).
x-ms-session-token string A string token False
(Session used with
Token) session level
consistency.
x-ms-activity-id string A client False
(Activity id) supplied
identifier for
the operation,
which will be
echoed in the
server
response.
databaseId string The name of True GetDatabases
(Database ID) the database

132 | P a g e
 Azure DocumentDB

collectionId string The name of True GetCollections

(Collection the collection
ID)
documentId string The identifier True
(Document for the
ID) document

Returns:
Type:getDocumentResponse

ReplaceDocument
Summary: Replace a document
Description: Replace a document

Syntax:
AzureDocumentDB.ReplaceDocument ([advanced][Optional]string x-
ms-documentdb-partitionkey, [advanced][Optional]number x-ms-max-
item-count, [advanced][Optional]string x-ms-continuation,
[advanced][Optional]string x-ms-consistency-level,
[advanced][Optional]string x-ms-session-token,
[advanced][Optional]string x-ms-activity-id, string databaseId,
string collectionId, string documentId, putDocumentRequest body)

Parameters:
Name Type Summary Required Related
Action
x-ms- string The partition False
documentdb- (Partition key value) key value for
partitionkey the
requested

133 | P a g e
 Azure DocumentDB

document or
attachment
operation.
x-ms-max-item- number An integer False
count (Max Item Count) indicating
the
maximum
number of
items to be
returned per
page.
x-ms- string A string False
continuation (Continuation Token) token
returned for
queries and
read-feed
operations if
there are
more results
to be read.
x-ms- string This is the False
consistency- (Consistency consistency
level Level)Values: [Strong, level
Bounded, Session, override. The
Eventual] valid values
are: Strong,
Bounded,
Session, or
Eventual (in

134 | P a g e
 Azure DocumentDB

order of
strongest to
weakest).
x-ms-session- string A string False
token (Session Token) token used
with session
level
consistency.
x-ms-activity-id string A client False
(Activity id) supplied
identifier for
the
operation,
which will be
echoed in
the server
response.
databaseId string The name of True GetDatabases
(Database ID) the database
collectionId string The name of True GetCollections
(Collection ID) the
collection
documentId string The True
(Document ID) identifier of
the
document
body putDocumentRequest True

135 | P a g e
 Azure DocumentDB

Returns:
Type:putDocumentResponse

DeleteDocument
Summary: Delete a document
Description: Delete a document

Syntax:
AzureDocumentDB.DeleteDocument ([advanced][Optional]string x-ms-
documentdb-partitionkey, [advanced][Optional]number x-ms-max-
item-count, [advanced][Optional]string x-ms-continuation,
[advanced][Optional]string x-ms-consistency-level,
[advanced][Optional]string x-ms-session-token,
[advanced][Optional]string x-ms-activity-id, string databaseId,
string collectionId, string documentId)

Parameters:
Name Type Summary Required Related
Action
x-ms-documentdb- string The partition False
partitionkey (Partition key key value for
value) the requested
document or
attachment
operation.
x-ms-max-item-count number An integer False
(Max Item indicating the
Count) maximum
number of
items to be

136 | P a g e
 Azure DocumentDB

returned per
page.
x-ms-continuation string A string token False
(Continuation returned for
Token) queries and
read-feed
operations if
there are more
results to be
read.
x-ms-consistency- string This is the False
level (Consistency consistency
Level)Values: level override.
[Strong, The valid
Bounded, values are:
Session, Strong,
Eventual] Bounded,
Session, or
Eventual (in
order of
strongest to
weakest).
x-ms-session-token string A string token False
(Session used with
Token) session level
consistency.
x-ms-activity-id string A client False
(Activity id) supplied
identifier for

137 | P a g e
 Azure DocumentDB

the operation,
which will be
echoed in the
server
response.
databaseId string The name of True GetDatabases
(Database ID) the document
collectionId string The name of True GetCollections
(Collection the collection
ID)
documentId string The identifier True
(Document of the
ID) document

Returns:

138 | P a g e
 Azure DocumentDB

getAccountResponse
Summary:
Description:

Properties:
Name Type Summary
_self string

_rid string

id string

139 | P a g e
 Azure DocumentDB

GetCollectionResponseItem
Summary:
Description:

Properties:
Name Type Summary
id string

indexingPolicy IndexingPolicy

_rid string

_ts integer(int32)

_self string

_etag string

_docs string

_sprocs string

_triggers string

_udfs string

_conflicts string

140 | P a g e
 Azure DocumentDB

IndexingPolicy
Summary:
Description:

Properties:
Name Type Summary
indexingMode string

automatic string

includedPaths array of
(IncludedPathsItem)

excludedPaths array of (string)

IncludedPathsItem
Summary:
Description:

Properties:
Name Type Summary
path string

indexes array of (IndexesItem)

IndexesItem
Summary:

141 | P a g e
 Azure DocumentDB

Description:

Properties:
Name Type Summary
kind string

dataType string

precision integer(int32)

142 | P a g e
 Azure DocumentDB

getCollectionsResponse
Summary:
Description:

Properties:
Name Type Summary
_rid string

DocumentCollections array of
(DocumentCollectionsItem)

_count integer(int32)

DocumentCollectionsItem
Summary:
Description:

Properties:
Name Type Summary
id string

indexingPolicy IndexingPolicy

_rid string

_ts integer(int32)

_self string

143 | P a g e
 Azure DocumentDB

_etag string

_docs string

_sprocs string

_triggers string

_udfs string

_conflicts string

IndexingPolicy
Summary:
Description:

Properties:
Name Type Summary
indexingMode string

automatic string

includedPaths array of
(IncludedPathsItem)

excludedPaths array of (string)

144 | P a g e
 Azure DocumentDB

IncludedPathsItem
Summary:
Description:

Properties:
Name Type Summary
path string

indexes array of (IndexesItem)

IndexesItem
Summary:
Description:

Properties:
Name Type Summary
kind string

dataType string

precision integer(int32)

145 | P a g e
 Azure DocumentDB

getDatabaseResponse
Summary:
Description:

Properties:
Name Type Summary
id string

_rid string

_self string

_etag string

_colls string

_users string

_ts integer(int32)

146 | P a g e
 Azure DocumentDB

getDatabasesResponse
Summary:
Description:

Properties:
Name Type Summary
_rid string

Databases array of (DatabasesItem)

_count integer(int32)

DatabasesItem
Summary:
Description:

Properties:
Name Type Summary
id string

_rid string

_self string

_etag string

_colls string

147 | P a g e
 Azure DocumentDB

_users string

_ts integer(int32)

148 | P a g e
 Azure DocumentDB

getDocumentResponse
Summary:
Description:

Properties:
Name Type Summary

149 | P a g e
 Azure DocumentDB

getDocumentsResponse
Summary:
Description:

Properties:
Name Type Summary
_rid string

Documents array of (DocumentsItem)

DocumentsItem
Summary:
Description:

Properties:
Name Type Summary

150 | P a g e
 Azure DocumentDB

postDocumentsRequest
Summary:
Description:

Properties:
Name Type Summary

151 | P a g e
 Azure DocumentDB

postDocumentsResponse
Summary:
Description:

Properties:
Name Type Summary
_rid string

_ts integer(int32)

_self string

_etag string

_attachments string

id string

152 | P a g e
 Azure DocumentDB

putDocumentRequest
Summary:
Description:

Properties:
Name Type Summary

153 | P a g e
 Azure DocumentDB

putDocumentResponse
Summary:
Description:

Properties:
Name Type Summary
_rid string

id string

154 | P a g e
 Azure DocumentDB

queryRequest
Summary:
Description:

Properties:
Name Type Summary
query string

155 | P a g e
 Azure DocumentDB

queryResponse
Summary:
Description:

Properties:
Name Type Summary
_rid string

_count number

Documents array of (DocumentsItem)

DocumentsItem
Summary:
Description:

Properties:
Name Type Summary

156 | P a g e
 Azure Queues

Azure Queues
Azure Queue storage provides cloud messaging between application
components. Queue storage also supports managing asynchronous tasks and
building process work flows.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
ListQueues () List queues
GetMessages (string Get messages
queueName, [Optional]string
numofmessages,
[advanced][Optional]string
visibilitytimeout)
PutMessage (string Put a message on a queue
queueName, string message)
DeleteMessage (string Delete message
queueName, string
messageId, string popreceipt)
PutQueue (string Create a new queue
queueName)

Triggers:
Name Summary
OnMessageThresholdReached When a specified number of messages are in a
(string queueName, integer given queue
threshold)

157 | P a g e
 Azure Queues

OnMessages (string When there are messages in a queue

queueName,
[advanced][Optional]string
visibilitytimeout)

Objects:
Name Summary
Messages
Queue

Actions:
ListQueues
Summary: List queues
Description: List all the queues for your storage account.

Syntax:
AzureQueues.ListQueues ()

Returns:
Type:array of (Queue)

GetMessages
Summary: Get messages
Description:

Syntax:
AzureQueues.GetMessages (string queueName, [Optional]string
numofmessages, [advanced][Optional]string visibilitytimeout)

158 | P a g e
 Azure Queues

Parameters:
Name Type Summary Required Related
Action
queueName string The queue to True ListQueues
(Queue get nessages
name) from
numofmessages string The number of False
(Number of messages to
messages) grab from the
queue (default
1.)
visibilitytimeout string The time in False
(Visibility seconds that
timeout) messages will be
invisibile to
other
consumers
(default 30)

Returns:
Type:Messages

PutMessage
Summary: Put a message on a queue
Description: Adds a message to the given queue

Syntax:
AzureQueues.PutMessage (string queueName, string message)

159 | P a g e
 Azure Queues

Parameters:
Name Type Summary Required Related
Action
queueName string The queue to True ListQueues
(Queue put a message
name) to
message string True

Returns:
Type:string

DeleteMessage
Summary: Delete message
Description:

Syntax:
AzureQueues.DeleteMessage (string queueName, string messageId,
string popreceipt)

Parameters:
Name Type Summary Required Related
Action
queueName string The queue to True ListQueues
(Queue delete a
name) message from

160 | P a g e
 Azure Queues

messageId string The ID of the True

(Message message to
ID) delete
popreceipt string A valid pop True
(Pop receipt value
receipt) returned from
an earlier call to
the Get
Messages

Returns:

PutQueue
Summary: Create a new queue
Description: Adds a queue to your account

Syntax:
AzureQueues.PutQueue (string queueName)

Parameters:
Name Type Summary Required Related
Action
queueName string The name of the True
(Queue queue to create
name)

Returns:
Type:string

161 | P a g e
 Azure Queues

Triggers:
Trigger OnMessageThresholdReached
Summary: When a specified number of messages are in a given queue
Description: Triggers when a specified number of messages are in the given queue.

Syntax:
AzureQueues.OnMessageThresholdReached (string queueName, integer
threshold)

Parameters:
Name Type Summary Required Related
Action
queueName string The queue to True ListQueues
(Queue check for
name) messages
threshold integer(int32) The number of True
(Threshold) messages to
wait for to fire
the trigger.

Returns:
Type:string

Trigger OnMessages
Summary: When there are messages in a queue
Description: Triggers any time there are messages in the queue, returning up to 32
messages.

Syntax:

162 | P a g e
 Azure Queues

AzureQueues.OnMessages (string queueName,

[advanced][Optional]string visibilitytimeout)

Parameters:
Name Type Summary Required Related
Action
queueName string The queue to True ListQueues
(Queue check for
name) messages
visibilitytimeout string The time in False
(Visibility seconds that
timeout) messages will be
invisibile to
other
consumers
(default 30)

Returns:
Type:Messages

163 | P a g e
 Azure Queues

Messages
Summary:
Description:

Properties:
Name Type Summary
QueueMessagesList QueueMessagesList

QueueMessagesList
Summary:
Description:

Properties:
Name Type Summary
QueueMessage array of
(QueueMessageItem)

QueueMessageItem
Summary:
Description:

Properties:
Name Type Summary
MessageId string The unique identifier of
Message ID the message
InsertionTime string The time the message was
Insertion time inserted into the queue

164 | P a g e
 Azure Queues

ExpirationTime string The time the message will

Expiration time expire from the queue
PopReceipt string Used to delete the
Pop receipt message after popping it
off the queue
TimeNextVisible string The time the message will
Next visibile time be visible to other
consumers
MessageText string The text of the message
Message text

165 | P a g e
 Azure Queues

Queue
Summary:
Description:

Properties:
Name Type Summary
Name string The name of the queue
Name

166 | P a g e
 Azure Resource Manager

Azure Resource Manager

Azure Resource Manager exposes the APIs to manage all of your Azure
resources.

Status: Preview Tier: Standard Version: 2016-06-01

Actions:
Name Summary
Subscriptions_ListLocations Lists the subscription locations
(string subscriptionId,
[internal]string api-version)
Subscriptions_Get Read a subscription
([internal]string api-version, string
subscriptionId)
Subscriptions_List List subscriptions
([internal]string api-version)
AsyncOperations_Get (string Reads an async operation (internal)
subscriptionId, string
operationResult, [internal]string
api-version)
Deployments_Delete (string Delete template deployment
subscriptionId, string
resourceGroupName, string
deploymentName, [internal]string
api-version)
Deployments_CreateOrUpdate Create or update a template deployment
(string subscriptionId, string
resourceGroupName, string

167 | P a g e
 Azure Resource Manager

deploymentName, Deployment
parameters, [internal]string api-
version)
Deployments_Get (string Read a template deployment
subscriptionId, string
resourceGroupName, string
deploymentName, [internal]string
api-version)
Deployments_Cancel (string Cancel a template deployment
subscriptionId, string
resourceGroupName, string
deploymentName, [internal]string
api-version)
Deployments_Validate (string Validate a template deployment
subscriptionId, string
resourceGroupName, string
deploymentName, Deployment
parameters, [internal]string api-
version)
Deployments_ExportTemplate Export deployment template
(string subscriptionId, string
resourceGroupName, string
deploymentName, [internal]string
api-version)
Deployments_List (string List template deployments
subscriptionId, string
resourceGroupName,
[advanced][Optional]string $filter,

168 | P a g e
 Azure Resource Manager

[advanced][Optional]integer
$top, [internal]string api-version)
DeploymentOperations_Get Read a template deployment operation
(string subscriptionId, string
resourceGroupName, string
deploymentName, string
operationId, [internal]string api-
version)
DeploymentOperations_List Lists template deployment operations
(string subscriptionId, string
resourceGroupName, string
deploymentName,
[advanced][Optional]integer
$top, [internal]string api-version)
Providers_Unregister (string Unregister resource provider
subscriptionId, string
resourceProviderNamespace,
[internal]string api-version)
Providers_Register (string Register resource provider
subscriptionId, string
resourceProviderNamespace,
[internal]string api-version)
Providers_List (string List resource providers
subscriptionId,
[advanced][Optional]integer
$top, [advanced][Optional]string
$expand, [internal]string api-
version)

169 | P a g e
 Azure Resource Manager

Providers_Get (string Read resource provider

subscriptionId, string
resourceProviderNamespace,
[advanced][Optional]string
$expand, [internal]string api-
version)
ResourceGroups_ListResources List resources by resource group
([internal]string api-version, string
subscriptionId, string
resourceGroupName,
[advanced][Optional]string $filter,
[advanced][Optional]string
$expand,
[advanced][Optional]integer
$top)
ResourceGroups_CreateOrUpdate Create or update a resource group
(string subscriptionId, string
resourceGroupName,
ResourceGroup parameters,
[internal]string api-version)
ResourceGroups_Delete (string Delete a resource group
subscriptionId, string
resourceGroupName,
[internal]string api-version)
ResourceGroups_Get (string Read a resource group
subscriptionId, string
resourceGroupName,
[internal]string api-version)

170 | P a g e
 Azure Resource Manager

ResourceGroups_Patch (string Update an existing resource group

subscriptionId, string
resourceGroupName,
ResourceGroup parameters,
[internal]string api-version)
ResourceGroups_ExportTemplate Export a resource group template
(string subscriptionId, string
resourceGroupName,
ExportTemplateRequest
parameters, [internal]string api-
version)
ResourceGroups_List List resource groups
([internal]string api-version, string
subscriptionId,
[advanced][Optional]string $filter,
[advanced][Optional]integer
$top)
Resources_List (string List resources by subscription
subscriptionId,
[advanced][Optional]string $filter,
[advanced][Optional]string
$expand,
[advanced][Optional]integer
$top, [internal]string api-version)
Resources_DeleteById (string Delete a resource.
subscriptionId, string
resourceGroupName, string
resourceProviderNamespace,

171 | P a g e
 Azure Resource Manager

string shortResourceId, string api-

version)
Resources_CreateOrUpdateById Create or update a resource
(string subscriptionId, string
resourceGroupName, string
resourceProviderNamespace,
string shortResourceId, string api-
version, GenericResource
parameters)
Resources_GetById (string Read a resource
subscriptionId, string
resourceGroupName, string
resourceProviderNamespace,
string shortResourceId, string api-
version)
Tags_DeleteValue (string Delete a subscription resource tag value
subscriptionId, string tagName,
string tagValue, [internal]string
api-version)
Tags_CreateOrUpdateValue Create or update a subscription resource tag
(string subscriptionId, string value
tagName, string tagValue,
[internal]string api-version)
Tags_CreateOrUpdate (string Create or update a subscription resource tag
subscriptionId, string tagName, name
[internal]string api-version)
Tags_Delete (string Delete a subscription resource tag name
subscriptionId, string tagName,
[internal]string api-version)

172 | P a g e
 Azure Resource Manager

Tags_List (string subscriptionId, List subscription resource tags

[internal]string api-version)

Triggers:
Name Summary

Objects:
Name Summary
AliasPathType
AliasType
AsyncOperations_GetResponse
BasicDependency
DebugSetting
Dependency
Deployment
DeploymentExportResult
DeploymentExtended
DeploymentListResult
DeploymentOperation
DeploymentOperationProperties
DeploymentOperationsListResult
DeploymentProperties
DeploymentPropertiesExtended
DeploymentValidateResult
ExportTemplateRequest
GenericResource
HttpMessage
Identity Identity

173 | P a g e
 Azure Resource Manager

Location
LocationListResult
ParametersLink
Plan
Provider
ProviderListResult
ProviderResourceType
ResourceGroup
ResourceGroupExportResult
ResourceGroupListResult
ResourceGroupProperties
ResourceListResult
ResourceManagementErrorWithDetails
Sku SKU
Subscription
SubscriptionListResult
SubscriptionPolicies Subscription Policies
TagCount Tag Count
TagDetails
TagsListResult
TagValue
TargetResource Target Resource
TemplateLink

Actions:
Subscriptions_ListLocations
Summary: Lists the subscription locations
Description: Lists the locations available for the subscription.

174 | P a g e
 Azure Resource Manager

Syntax:
AzureResourceManager.Subscriptions_ListLocations (string
subscriptionId, [internal]string api-version)

Parameters:
Name Type Summary Required Related Action
subscriptionId string The unique True Subscriptions_List
(Subscription) identifier for
the Microsoft
Azure
subscription.
The
subscription
ID forms part
of the ID for
every Azure
resource.
api-version string Client Api True
Values: Version.
[2016-06-01]

Returns:
Type:LocationListResult
Description: Location list operation response.

Subscriptions_Get
Summary: Read a subscription
Description: Reads the details for a particular subscription.

175 | P a g e
 Azure Resource Manager

Syntax:
AzureResourceManager.Subscriptions_Get ([internal]string api-
version, string subscriptionId)

Parameters:
Name Type Summary Required Related Action
api-version string Client Api True
Values: Version.
[2016-06-01]
subscriptionId string The unique True Subscriptions_List
(Subscription) identifier for
the Microsoft
Azure
subscription.
The
subscription
ID forms part
of the ID for
every Azure
resource.

Returns:
Type:Subscription
Description: Subscription information.

Subscriptions_List
Summary: List subscriptions
Description: Gets a list of all the subscriptions to which the principal has access.

176 | P a g e
 Azure Resource Manager

Syntax:
AzureResourceManager.Subscriptions_List ([internal]string api-
version)

Parameters:
Name Type Summary Required Related
Action
api-version string Client Api True
Values: Version.
[2016-06-
01]

Returns:
Type:SubscriptionListResult
Description: Subscription list operation response.

AsyncOperations_Get
Summary: Reads an async operation (internal)
Description: Reads an async operation (internal).

Syntax:
AzureResourceManager.AsyncOperations_Get (string subscriptionId,
string operationResult, [internal]string api-version)

Parameters:
Name Type Summary Required Related Action
subscriptionId string The unique True Subscriptions_List
(Subscription) identifier for
the Microsoft

177 | P a g e
 Azure Resource Manager

Azure
subscription.
The
subscription
ID forms part
of the ID for
every Azure
resource.
operationResult string The operation True
result Id.
api-version string Client Api True
Values: Version.
[2016-06-01]

Returns:
Type:AsyncOperations_GetResponse
Description: Async operations response.

Deployments_Delete
Summary: Delete template deployment
Description: Deletes a resource group template deployment. The resources will not be
deleted; only the metadata about the template deployment.

Syntax:
AzureResourceManager.Deployments_Delete (string subscriptionId,
string resourceGroupName, string deploymentName,
[internal]string api-version)

Parameters:

178 | P a g e
 Azure Resource Manager

Name Type Summary Require Related Action

d
subscriptionId string The unique True Subscriptions_List
(Subscription identifier
) for the
Microsoft
Azure
subscription
. The
subscription
ID forms
part of the
ID for every
Azure
resource.
resourceGroupNam string Resource True ResourceGroups_Lis
e (Resource group t
Group) name.
deploymentName string The name True Deployments_List
(Deployment of the
Name) resource
group
template
deployment
.
api-version string Client Api True
Values: Version.
[2016-06-01]

179 | P a g e
 Azure Resource Manager

Returns:

Deployments_CreateOrUpdate
Summary: Create or update a template deployment
Description: Create or update a named resource group template deployment. A
template and parameters are expected for the request to succeed.

Syntax:
AzureResourceManager.Deployments_CreateOrUpdate (string
subscriptionId, string resourceGroupName, string deploymentName,
Deployment parameters, [internal]string api-version)

Parameters:
Name Type Summary Require Related Action
d
subscriptionId string The unique True Subscriptions_List
(Subscription identifier
) for the
Microsoft
Azure
subscription
. The
subscription
ID forms
part of the
ID for every
Azure
resource.

180 | P a g e
 Azure Resource Manager

resourceGroupNam string Resource True ResourceGroups_Lis

e (Resource group t
Group) name.
deploymentName string The name True
of the
deployment
.
parameters Deployment Deployment True
operation
parameters.
api-version string Client Api True
Values: Version.
[2016-06-01]

Returns:
Type:DeploymentExtended
Description: Deployment information.

Deployments_Get
Summary: Read a template deployment
Description: Reads a template deployment within a resource group.

Syntax:
AzureResourceManager.Deployments_Get (string subscriptionId,
string resourceGroupName, string deploymentName,
[internal]string api-version)

Parameters:

181 | P a g e
 Azure Resource Manager

Name Type Summary Require Related Action

d
subscriptionId string The unique True Subscriptions_List
(Subscription identifier
) for the
Microsoft
Azure
subscription
. The
subscription
ID forms
part of the
ID for every
Azure
resource.
resourceGroupNam string Resource True ResourceGroups_Lis
e (Resource group t
Group) name.
deploymentName string The name True Deployments_List
(Deployment of the
Name) resource
group
template
deployment
.
api-version string Client Api True
Values: Version.
[2016-06-01]

182 | P a g e
 Azure Resource Manager

Returns:
Type:DeploymentExtended
Description: Deployment information.

Deployments_Cancel
Summary: Cancel a template deployment
Description: Cancel a currently running template deployment. All pending template
operations will be suspended.

Syntax:
AzureResourceManager.Deployments_Cancel (string subscriptionId,
string resourceGroupName, string deploymentName,
[internal]string api-version)

Parameters:
Name Type Summary Require Related Action
d
subscriptionId string The unique True Subscriptions_List
(Subscription identifier
) for the
Microsoft
Azure
subscription
. The
subscription
ID forms
part of the
ID for every

183 | P a g e
 Azure Resource Manager

Azure
resource.
resourceGroupNam string Resource True ResourceGroups_Lis
e (Resource group t
Group) name.
deploymentName string The name True Deployments_List
(Deployment of the
Name) resource
group
template
deployment
.
api-version string Client Api True
Values: Version.
[2016-06-01]

Returns:

Deployments_Validate
Summary: Validate a template deployment
Description: Validates a deployment template. This operation does not have side
effects and can be used to test a template deployment for syntax or logical errors.

Syntax:
AzureResourceManager.Deployments_Validate (string
subscriptionId, string resourceGroupName, string deploymentName,
Deployment parameters, [internal]string api-version)

Parameters:

184 | P a g e
 Azure Resource Manager

Name Type Summary Require Related Action

d
subscriptionId string The unique True Subscriptions_List
(Subscription identifier
) for the
Microsoft
Azure
subscription
. The
subscription
ID forms
part of the
ID for every
Azure
resource.
resourceGroupNam string Resource True ResourceGroups_Lis
e (Resource group t
Group) name.
deploymentName string The name True Deployments_List
(Deployment of the
Name) resource
group
template
deployment
.
parameters Deployment Deployment True
operation
parameters.

185 | P a g e
 Azure Resource Manager

api-version string Client Api True

Values: Version.
[2016-06-01]

Returns:
Type:DeploymentValidateResult
Description: Information from validate template deployment response.

Deployments_ExportTemplate
Summary: Export deployment template
Description: Exports a template from a past resource group deployment.

Syntax:
AzureResourceManager.Deployments_ExportTemplate (string
subscriptionId, string resourceGroupName, string deploymentName,
[internal]string api-version)

Parameters:
Name Type Summary Require Related Action
d
subscriptionId string The unique True Subscriptions_List
(Subscription identifier
) for the
Microsoft
Azure
subscription
. The
subscription
ID forms

186 | P a g e
 Azure Resource Manager

part of the
ID for every
Azure
resource.
resourceGroupNam string Resource True ResourceGroups_Lis
e (Resource group t
Group) name.
deploymentName string The name True Deployments_List
(Deployment of the
Name) resource
group
template
deployment
.
api-version string Client Api True
Values: Version.
[2016-06-01]

Returns:
Type:DeploymentExportResult
Description: The deployment export result.

Deployments_List
Summary: List template deployments
Description: Lists all the resource group template deployments. This operation is
useful to know what has been provisioned thus far.

Syntax:

187 | P a g e
 Azure Resource Manager

AzureResourceManager.Deployments_List (string subscriptionId,

string resourceGroupName, [advanced][Optional]string $filter,
[advanced][Optional]integer $top, [internal]string api-version)

Parameters:
Name Type Summary Require Related Action
d
subscriptionId string The unique True Subscriptions_List
(Subscription identifier
) for the
Microsoft
Azure
subscription
. The
subscription
ID forms
part of the
ID for every
Azure
resource.
resourceGroupNam string Resource True ResourceGroups_Lis
e (Resource group t
Group) name.
$filter string The filter to False
apply on the
operation.
$top integer(int32 Query False
) parameters.
If nothing is

188 | P a g e
 Azure Resource Manager

passed
returns all
values.
api-version string Client Api True
Values: Version.
[2016-06-01]

Returns:
Type:DeploymentListResult
Description: List of deployments.

DeploymentOperations_Get
Summary: Read a template deployment operation
Description: Reads a particular resource group template deployment operation. This is
useful for troubleshooting failed template deployments.

Syntax:
AzureResourceManager.DeploymentOperations_Get (string
subscriptionId, string resourceGroupName, string deploymentName,
string operationId, [internal]string api-version)

Parameters:
Name Type Summary Require Related Action
d
subscriptionId string The unique True Subscriptions_List
(Subscription identifier
) for the
Microsoft
Azure

189 | P a g e
 Azure Resource Manager

subscription
. The
subscription
ID forms
part of the
ID for every
Azure
resource.
resourceGroupNam string Resource True ResourceGroups_Lis
e (Resource group t
Group) name.
deploymentName string The name True Deployments_List
(Deployment of the
Name) resource
group
template
deployment
.
operationId string Operation True
Id.
api-version string Client Api True
Values: Version.
[2016-06-01]

Returns:
Type:DeploymentOperation
Description: Deployment operation information.

190 | P a g e
 Azure Resource Manager

DeploymentOperations_List
Summary: Lists template deployment operations
Description: Lists all the template deployment operations. This is useful for
troubleshooting failed template deployments.

Syntax:
AzureResourceManager.DeploymentOperations_List (string
subscriptionId, string resourceGroupName, string deploymentName,
[advanced][Optional]integer $top, [internal]string api-version)

Parameters:
Name Type Summary Require Related Action
d
subscriptionId string The unique True Subscriptions_List
(Subscription identifier
) for the
Microsoft
Azure
subscription
. The
subscription
ID forms
part of the
ID for every
Azure
resource.
resourceGroupNam string Resource True ResourceGroups_Lis
e (Resource group t
Group) name.

191 | P a g e
 Azure Resource Manager

deploymentName string The name True Deployments_List

(Deployment of the
Name) resource
group
template
deployment
.
$top integer(int32 Query False
) parameters.
If nothing is
passed
returns all
values.
api-version string Client Api True
Values: Version.
[2016-06-01]

Returns:
Type:DeploymentOperationsListResult
Description: List of deployment operations.

Providers_Unregister
Summary: Unregister resource provider
Description: Unregisters provider from a subscription. This operation will fail if there
are any resources from that resource provider in the subscription.

Syntax:

192 | P a g e
 Azure Resource Manager

AzureResourceManager.Providers_Unregister (string
subscriptionId, string resourceProviderNamespace,
[internal]string api-version)

Parameters:
Name Type Summary Require Related Action
d
subscriptionId string The unique True Subscriptions_Li
(Subscriptio identifier st
n) for the
Microsoft
Azure
subscriptio
n. The
subscriptio
n ID forms
part of the
ID for every
Azure
resource.
resourceProviderNamesp string Namespace True Providers_List
ace (Resource of the
Provider) resource
provider.
api-version string Client Api True
Values: Version.
[2016-06-
01]

Returns:
193 | P a g e
 Azure Resource Manager

Type:Provider
Description: Resource provider information.

Providers_Register
Summary: Register resource provider
Description: Registers a resource provider to be used with a subscription. This will
provision permissions for the service into your subscription.

Syntax:
AzureResourceManager.Providers_Register (string subscriptionId,
string resourceProviderNamespace, [internal]string api-version)

Parameters:
Name Type Summary Require Related Action
d
subscriptionId string The unique True Subscriptions_Li
(Subscriptio identifier st
n) for the
Microsoft
Azure
subscriptio
n. The
subscriptio
n ID forms
part of the
ID for every
Azure
resource.

194 | P a g e
 Azure Resource Manager

resourceProviderNamesp string Namespace True Providers_List

ace (Resource of the
Provider) resource
provider.
api-version string Client Api True
Values: Version.
[2016-06-
01]

Returns:
Type:Provider
Description: Resource provider information.

Providers_List
Summary: List resource providers
Description: Lists the resource providers available for the subscription.

Syntax:
AzureResourceManager.Providers_List (string subscriptionId,
[advanced][Optional]integer $top, [advanced][Optional]string
$expand, [internal]string api-version)

Parameters:
Name Type Summary Required Related Action
subscriptionId string The unique True Subscriptions_List
(Subscription) identifier for
the Microsoft
Azure
subscription.

195 | P a g e
 Azure Resource Manager

The
subscription
ID forms part
of the ID for
every Azure
resource.
$top integer(int32) Query False
parameters. If
nothing is
passed returns
all values.
$expand string The $expand False
query
parameter.
api-version string Client Api True
Values: Version.
[2016-06-01]

Returns:
Type:ProviderListResult
Description: List of resource providers.

Providers_Get
Summary: Read resource provider
Description: Reads a particular resource provider within the subscription.

Syntax:

196 | P a g e
 Azure Resource Manager

AzureResourceManager.Providers_Get (string subscriptionId,

string resourceProviderNamespace, [advanced][Optional]string
$expand, [internal]string api-version)

Parameters:
Name Type Summary Require Related Action
d
subscriptionId string The unique True Subscriptions_Li
(Subscriptio identifier st
n) for the
Microsoft
Azure
subscriptio
n. The
subscriptio
n ID forms
part of the
ID for every
Azure
resource.
resourceProviderNamesp string Namespace True Providers_List
ace (Resource of the
Provider) resource
provider.
$expand string The False
$expand
query
parameter.

197 | P a g e
 Azure Resource Manager

api-version string Client Api True

Values: Version.
[2016-06-
01]

Returns:
Type:Provider
Description: Resource provider information.

ResourceGroups_ListResources
Summary: List resources by resource group
Description: Lists all the resources under a resource group.

Syntax:
AzureResourceManager.ResourceGroups_ListResources
([internal]string api-version, string subscriptionId, string
resourceGroupName, [advanced][Optional]string $filter,
[advanced][Optional]string $expand, [advanced][Optional]integer
$top)

Parameters:
Name Type Summary Require Related Action
d
api-version string Client Api True
Values: Version.
[2016-06-01]
subscriptionId string The unique True Subscriptions_List
(Subscription identifier
) for the
Microsoft

198 | P a g e
 Azure Resource Manager

Azure
subscription
. The
subscription
ID forms
part of the
ID for every
Azure
resource.
resourceGroupNam string Resource True ResourceGroups_Lis
e (Resource group t
Group) name.
$filter string The filter to False
apply on the
operation.
$expand string The False
$expand
query
parameter.
$top integer(int32 Query False
) parameters.
If nothing is
passed
returns all
values.

Returns:
Type:ResourceListResult
Description: List of resource groups.

199 | P a g e
 Azure Resource Manager

ResourceGroups_CreateOrUpdate
Summary: Create or update a resource group
Description: Creates or updates a resource group. The response code will indicate if it
were a create or update.

Syntax:
AzureResourceManager.ResourceGroups_CreateOrUpdate (string
subscriptionId, string resourceGroupName, ResourceGroup
parameters, [internal]string api-version)

Parameters:
Name Type Summary Require Related Action
d
subscriptionId string The unique True Subscriptions_Lis
(Subscription) identifier for t
the
Microsoft
Azure
subscription
. The
subscription
ID forms
part of the
ID for every
Azure
resource.
resourceGroupNam string The name of True
e the resource

200 | P a g e
 Azure Resource Manager

(Resource group to be
Group Name) created or
updated.
parameters ResourceGrou Resource True
p group
information.
api-version string Client Api True
Values: [2016- Version.
06-01]

Returns:
Type:ResourceGroup
Description: Resource group information.

ResourceGroups_Delete
Summary: Delete a resource group
Description: Delete a particular resource group within the subscription.

Syntax:
AzureResourceManager.ResourceGroups_Delete (string
subscriptionId, string resourceGroupName, [internal]string api-
version)

Parameters:
Name Type Summary Require Related Action
d
subscriptionId string The unique True Subscriptions_List
(Subscription identifier
) for the

201 | P a g e
 Azure Resource Manager

Microsoft
Azure
subscription
. The
subscription
ID forms
part of the
ID for every
Azure
resource.
resourceGroupNam string Resource True ResourceGroups_Lis
e (Resource group t
Group) name.
api-version string Client Api True
Values: Version.
[2016-06-01]

Returns:

ResourceGroups_Get
Summary: Read a resource group
Description: Reads a particular resource group within the subscription.

Syntax:
AzureResourceManager.ResourceGroups_Get (string subscriptionId,
string resourceGroupName, [internal]string api-version)

Parameters:

202 | P a g e
 Azure Resource Manager

Name Type Summary Require Related Action

d
subscriptionId string The unique True Subscriptions_List
(Subscription identifier
) for the
Microsoft
Azure
subscription
. The
subscription
ID forms
part of the
ID for every
Azure
resource.
resourceGroupNam string Resource True ResourceGroups_Lis
e (Resource group t
Group) name.
api-version string Client Api True
Values: Version.
[2016-06-01]

Returns:
Type:ResourceGroup
Description: Resource group information.

ResourceGroups_Patch
Summary: Update an existing resource group

203 | P a g e
 Azure Resource Manager

Description: Updates an existing resource group. If the resource does not exist, this
request will fail.

Syntax:
AzureResourceManager.ResourceGroups_Patch (string
subscriptionId, string resourceGroupName, ResourceGroup
parameters, [internal]string api-version)

Parameters:
Name Type Summary Require Related Action
d
subscriptionId string The unique True Subscriptions_List
(Subscription) identifier
for the
Microsoft
Azure
subscription
. The
subscription
ID forms
part of the
ID for every
Azure
resource.
resourceGroupNam string Resource True ResourceGroups_Li
e (Resource group st
Group) name.
parameters ResourceGrou Resource True
p group

204 | P a g e
 Azure Resource Manager

information
.
api-version string Client Api True
Values: [2016- Version.
06-01]

Returns:
Type:ResourceGroup
Description: Resource group information.

ResourceGroups_ExportTemplate
Summary: Export a resource group template
Description: Exports a deployment template from an existing resource group. This can
only be successful if the underlying resources have a schema defined by Microsoft.

Syntax:
AzureResourceManager.ResourceGroups_ExportTemplate (string
subscriptionId, string resourceGroupName, ExportTemplateRequest
parameters, [internal]string api-version)

Parameters:
Name Type Summary Require Related Action
d
subscriptionId string The True Subscriptions_List
(Subscription) unique
identifier
for the
Microsoft
Azure

205 | P a g e
 Azure Resource Manager

subscriptio
n. The
subscriptio
n ID forms
part of the
ID for
every
Azure
resource.
resourceGroupNa string Resource True ResourceGroups_
me (Resource Group) group List
name.
parameters ExportTemplateReq Export True
uest resource
group
template
request
parameter
s.
api-version string Client Api True
Values: [2016-06- Version.
01]

Returns:
Type:ResourceGroupExportResult

ResourceGroups_List
Summary: List resource groups

206 | P a g e
 Azure Resource Manager

Description: Lists all the resource groups within the subscription. Paginates at 1,000
records.

Syntax:
AzureResourceManager.ResourceGroups_List ([internal]string api-
version, string subscriptionId, [advanced][Optional]string
$filter, [advanced][Optional]integer $top)

Parameters:
Name Type Summary Required Related Action
api-version string Client Api True
Values: Version.
[2016-06-01]
subscriptionId string The unique True Subscriptions_List
(Subscription) identifier for
the Microsoft
Azure
subscription.
The
subscription
ID forms part
of the ID for
every Azure
resource.
$filter string The filter to False
apply on the
operation.
$top integer(int32) Query False
parameters. If

207 | P a g e
 Azure Resource Manager

nothing is
passed returns
all values.

Returns:
Type:ResourceGroupListResult
Description: List of resource groups.

Resources_List
Summary: List resources by subscription
Description: Reads all of the resources under a particular subscription. The results are
paginated at 1,000+ records.

Syntax:
AzureResourceManager.Resources_List (string subscriptionId,
[advanced][Optional]string $filter, [advanced][Optional]string
$expand, [advanced][Optional]integer $top, [internal]string api-
version)

Parameters:
Name Type Summary Required Related Action
subscriptionId string The unique True Subscriptions_List
(Subscription) identifier for
the Microsoft
Azure
subscription.
The
subscription
ID forms part

208 | P a g e
 Azure Resource Manager

of the ID for
every Azure
resource.
$filter string The filter to False
apply on the
operation.
$expand string The $expand False
query
parameter.
$top integer(int32) Query False
parameters. If
nothing is
passed returns
all values.
api-version string Client Api True
Values: Version.
[2016-06-01]

Returns:
Type:ResourceListResult
Description: List of resource groups.

Resources_DeleteById
Summary: Delete a resource.
Description: Deletes a resource.

Syntax:
AzureResourceManager.Resources_DeleteById (string
subscriptionId, string resourceGroupName, string

209 | P a g e
 Azure Resource Manager

resourceProviderNamespace, string shortResourceId, string api-

version)

Parameters:
Name Type Summary Req Related
uire Action
d
subscriptionId string The unique identifier for the True Subscripti
(Subsc Microsoft Azure subscription. The ons_List
ription subscription ID forms part of the ID
) for every Azure resource.
resourceGroup string Resource group name. True ResourceG
Name (Resou roups_List
rce
Group)
resourceProvid string Namespace of the resource provider. True Providers_
erNamespace (Resou List
rce
Provid
er)
shortResourceI string The fully qualified Id of the resource, True
d including the resource name and
resource type. For example,
/subscriptions/00000000-0000-0000-
0000-
000000000000/resourceGroups/myG
roup/Microsoft.Web/sites/mySite
api-version string Client Api Version. True

210 | P a g e
 Azure Resource Manager

Returns:

Resources_CreateOrUpdateById
Summary: Create or update a resource
Description: Creates or updates a resource. The response code can be used to
distinguish between a create (201) or update (200).

Syntax:
AzureResourceManager.Resources_CreateOrUpdateById (string
subscriptionId, string resourceGroupName, string
resourceProviderNamespace, string shortResourceId, string api-
version, GenericResource parameters)

Parameters:
Name Type Summary Req Related
uire Action
d
subscriptionId string The unique identifier for the True Subscripti
(Subscri Microsoft Azure subscription. The ons_List
ption) subscription ID forms part of the ID
for every Azure resource.
resourceGrou string Resource group name. True ResourceG
pName (Resour roups_List
ce
Group)
resourceProvi string Namespace of the resource True Providers_
derNamespac (Resour provider. List
e ce

211 | P a g e
 Azure Resource Manager

Provider
)
shortResource string The fully qualified Id of the resource, True
Id including the resource name and
resource type. For example,
/subscriptions/00000000-0000-
0000-0000-
000000000000/resourceGroups/my
Group/Microsoft.Web/sites/mySite
api-version string Client Api Version. True

parameters Generic Resource information. True

Resourc
e

Returns:
Type:GenericResource
Description: Resource information.

Resources_GetById
Summary: Read a resource
Description: Reads a resource object.

Syntax:
AzureResourceManager.Resources_GetById (string subscriptionId,
string resourceGroupName, string resourceProviderNamespace,
string shortResourceId, string api-version)

212 | P a g e
 Azure Resource Manager

Parameters:
Name Type Summary Req Related
uire Action
d
subscriptionId string The unique identifier for the True Subscripti
(Subsc Microsoft Azure subscription. The ons_List
ription subscription ID forms part of the ID
) for every Azure resource.
resourceGroup string Resource group name. True ResourceG
Name (Resou roups_List
rce
Group)
resourceProvid string Namespace of the resource provider. True Providers_
erNamespace (Resou List
rce
Provid
er)
shortResourceI string The fully qualified Id of the resource, True
d including the resource name and
resource type. For example,
/subscriptions/00000000-0000-0000-
0000-
000000000000/resourceGroups/myG
roup/Microsoft.Web/sites/mySite
api-version string Client Api Version. True

Returns:
Type:GenericResource

213 | P a g e
 Azure Resource Manager

Description: Resource information.

Tags_DeleteValue
Summary: Delete a subscription resource tag value
Description: Delete a subscription resource tag value.

Syntax:
AzureResourceManager.Tags_DeleteValue (string subscriptionId,
string tagName, string tagValue, [internal]string api-version)

Parameters:
Name Type Summary Required Related Action
subscriptionId string The unique True Subscriptions_List
(Subscription) identifier for
the Microsoft
Azure
subscription.
The
subscription
ID forms part
of the ID for
every Azure
resource.
tagName string The name of True Tags_List
(Tag Name) the tag.
tagValue string The value of True
the tag.
api-version string Client Api True
Version.

214 | P a g e
 Azure Resource Manager

Values:
[2016-06-01]

Returns:

Tags_CreateOrUpdateValue
Summary: Create or update a subscription resource tag value
Description: Create or update a subscription resource tag value.

Syntax:
AzureResourceManager.Tags_CreateOrUpdateValue (string
subscriptionId, string tagName, string tagValue,
[internal]string api-version)

Parameters:
Name Type Summary Required Related Action
subscriptionId string The unique True Subscriptions_List
(Subscription) identifier for
the Microsoft
Azure
subscription.
The
subscription
ID forms part
of the ID for
every Azure
resource.
tagName string The name of True Tags_List
(Tag Name) the tag.

215 | P a g e
 Azure Resource Manager

tagValue string The value of True

the tag.
api-version string Client Api True
Values: Version.
[2016-06-01]

Returns:
Type:TagValue
Description: Tag information.

Tags_CreateOrUpdate
Summary: Create or update a subscription resource tag name
Description: Create or update a subscription resource tag name.

Syntax:
AzureResourceManager.Tags_CreateOrUpdate (string subscriptionId,
string tagName, [internal]string api-version)

Parameters:
Name Type Summary Required Related Action
subscriptionId string The unique True Subscriptions_List
(Subscription) identifier for
the Microsoft
Azure
subscription.
The
subscription
ID forms part
of the ID for

216 | P a g e
 Azure Resource Manager

every Azure
resource.
tagName string The name of True
(Tag Name) the tag.
api-version string Client Api True
Values: Version.
[2016-06-01]

Returns:
Type:TagDetails
Description: Tag details.

Tags_Delete
Summary: Delete a subscription resource tag name
Description: Delete a subscription resource tag name.

Syntax:
AzureResourceManager.Tags_Delete (string subscriptionId, string
tagName, [internal]string api-version)

Parameters:
Name Type Summary Required Related Action
subscriptionId string The unique True Subscriptions_List
(Subscription) identifier for
the Microsoft
Azure
subscription.
The
subscription

217 | P a g e
 Azure Resource Manager

ID forms part
of the ID for
every Azure
resource.
tagName string The name of True Tags_List
(Tag Name) the tag.
api-version string Client Api True
Values: Version.
[2016-06-01]

Returns:

Tags_List
Summary: List subscription resource tags
Description: Lists all the subscription resource tags.

Syntax:
AzureResourceManager.Tags_List (string subscriptionId,
[internal]string api-version)

Parameters:
Name Type Summary Required Related Action
subscriptionId string The unique True Subscriptions_List
(Subscription) identifier for
the Microsoft
Azure
subscription.
The
subscription

218 | P a g e
 Azure Resource Manager

ID forms part
of the ID for
every Azure
resource.
api-version string Client Api True
Values: Version.
[2016-06-01]

Returns:
Type:TagsListResult
Description: List of subscription tags.

219 | P a g e
 Azure Resource Manager

AliasPathType
Summary:
Description: The type of the paths for alias.

Properties:
Name Type Summary
path string The path of an alias.

apiVersions array of (string) The api versions.

220 | P a g e
 Azure Resource Manager

AliasType
Summary:
Description: The alias type.

Properties:
Name Type Summary
name string The alias name.

paths array of (AliasPathType) The paths for an alias.

221 | P a g e
 Azure Resource Manager

AsyncOperations_GetResponse
Summary:
Description: Async operations response.

Properties:
Name Type Summary

222 | P a g e
 Azure Resource Manager

BasicDependency
Summary:
Description: Deployment dependency information.

Properties:
Name Type Summary
id string The ID of the dependency.

resourceType string The dependency resource

type.
resourceName string The dependency resource
name.

223 | P a g e
 Azure Resource Manager

DebugSetting
Summary:
Description:

Properties:
Name Type Summary
detailLevel string The debug detail level.

224 | P a g e
 Azure Resource Manager

Dependency
Summary:
Description: Deployment dependency information.

Properties:
Name Type Summary
dependsOn array of The list of dependencies.
(BasicDependency)

id string The ID of the dependency.

resourceType string The dependency resource

type.
resourceName string The dependency resource
name.

225 | P a g e
 Azure Resource Manager

Deployment
Summary:
Description: Deployment operation parameters.

Properties:
Name Type Summary
properties DeploymentProperties Deployment properties.

226 | P a g e
 Azure Resource Manager

DeploymentExportResult
Summary:
Description: The deployment export result.

Properties:
Name Type Summary
template Template The template content.
Template

Template
Summary: Template
Description: The template content.

Properties:
Name Type Summary

227 | P a g e
 Azure Resource Manager

DeploymentExtended
Summary:
Description: Deployment information.

Properties:
Name Type Summary
id string The ID of the
Id deployment.
name string The name of the
Name deployment.
properties DeploymentPropertiesExtended Deployment properties
with additional details.

228 | P a g e
 Azure Resource Manager

DeploymentListResult
Summary:
Description: List of deployments.

Properties:
Name Type Summary
value array of The list of deployments.
(DeploymentExtended)

nextLink string The URL to get the next

Next Link set of results.

229 | P a g e
 Azure Resource Manager

DeploymentOperation
Summary:
Description: Deployment operation information.

Properties:
Name Type Summary
id string Full deployment
Id operation id.
operationId string Deployment operation
Operation Id id.
properties DeploymentOperationProperties Deployment operation
properties.

230 | P a g e
 Azure Resource Manager

DeploymentOperationProperties
Summary:
Description: Deployment operation properties.

Properties:
Name Type Summary
provisioningState string The state of the
provisioning.
timestamp string(date-time) The date and time of the
operation.
serviceRequestId string Deployment operation
service request id.
statusCode string Operation status code.

statusMessage StatusMessage Operation status

message.
targetResource TargetResource Target resource.
Target Resource
request HttpMessage

response HttpMessage

StatusMessage
Summary:
Description: Operation status message.

Properties:
Name Type Summary

231 | P a g e
Azure Resource Manager

232 | P a g e
 Azure Resource Manager

DeploymentOperationsListResult
Summary:
Description: List of deployment operations.

Properties:
Name Type Summary
value array of The list of deployments.
(DeploymentOperation)

nextLink string The URL to get the next

Next Link set of results.

233 | P a g e
 Azure Resource Manager

DeploymentProperties
Summary:
Description: Deployment properties.

Properties:
Name Type Summary
template Template The template content. It
can be a JObject or a well
formed JSON string. Use
only one of Template or
TemplateLink.
templateLink TemplateLink Entity representing the
reference to the template.
parameters Parameters Deployment parameters.
It can be a JObject or a
well formed JSON string.
Use only one of
Parameters or
ParametersLink.
parametersLink ParametersLink Entity representing the
reference to the
deployment paramaters.
mode string The deployment mode.
Values: [Incremental,
Complete]
debugSetting DebugSetting

234 | P a g e
 Azure Resource Manager

Template
Summary:
Description: The template content. It can be a JObject or a well formed JSON string.
Use only one of Template or TemplateLink.

Properties:
Name Type Summary

Parameters
Summary:
Description: Deployment parameters. It can be a JObject or a well formed JSON string.
Use only one of Parameters or ParametersLink.

Properties:
Name Type Summary

235 | P a g e
 Azure Resource Manager

DeploymentPropertiesExtended
Summary:
Description: Deployment properties with additional details.

Properties:
Name Type Summary
provisioningState string The state of the
provisioning.
correlationId string The correlation ID of the
deployment.
timestamp string(date-time) The timestamp of the
template deployment.
outputs Outputs Key/value pairs that
represent
deploymentoutput.
providers array of (Provider) The list of resource
providers needed for the
deployment.
dependencies array of (Dependency) The list of deployment
dependencies.
template Template The template content. Use
only one of Template or
TemplateLink.
templateLink TemplateLink Entity representing the
reference to the template.
parameters Parameters Deployment parameters.
Use only one of
Parameters or
ParametersLink.

236 | P a g e
 Azure Resource Manager

parametersLink ParametersLink Entity representing the

reference to the
deployment paramaters.
mode string The deployment mode.
Values: [Incremental,
Complete]
debugSetting DebugSetting

Outputs
Summary:
Description: Key/value pairs that represent deploymentoutput.

Properties:
Name Type Summary

Template
Summary:
Description: The template content. Use only one of Template or TemplateLink.

Properties:
Name Type Summary

Parameters
Summary:
Description: Deployment parameters. Use only one of Parameters or ParametersLink.

Properties:

237 | P a g e
 Azure Resource Manager

Name Type Summary

238 | P a g e
 Azure Resource Manager

DeploymentValidateResult
Summary:
Description: Information from validate template deployment response.

Properties:
Name Type Summary
error ResourceManagementErrorWithDetails

properties DeploymentPropertiesExtended Deployment

properties with
additional details.

239 | P a g e
 Azure Resource Manager

ExportTemplateRequest
Summary:
Description: Export resource group template request parameters.

Properties:
Name Type Summary
resources array of (string) The ids of the resources. The
only supported string currently
is '*' (all resources). Future api
updates will support exporting
specific resources. Values: [*]
options string The export template options.
Supported values include
'IncludeParameterDefaultValue',
'IncludeComments' or
'IncludeParameterDefaultValue,
IncludeComments Values:
[IncludeParameterDefaultValue,
IncludeComments,
IncludeParameterDefaultValue,
IncludeComments]

240 | P a g e
 Azure Resource Manager

GenericResource
Summary:
Description: Resource information.

Properties:
Name Type Summary
id string Resource Id
Id
name string Resource name
Name
type string Resource type
Type
location string Resource location
Location
tags Tags Resource tags
Tags
plan Plan Plan for the resource.

kind string The kind of the resource.

Kind
managedBy string Id of the resource that
Managed By manages this resource.
sku Sku Sku for the resource.
SKU
identity Identity Identity for the resource.
Identity
properties Properties The resource properties.
Properties

241 | P a g e
 Azure Resource Manager

Tags
Summary: Tags
Description: Resource tags

Properties:
Name Type Summary

Properties
Summary: Properties
Description: The resource properties.

Properties:
Name Type Summary

242 | P a g e
 Azure Resource Manager

HttpMessage
Summary:
Description:

Properties:
Name Type Summary
content Content HTTP message content.

Content
Summary:
Description: HTTP message content.

Properties:
Name Type Summary

243 | P a g e
 Azure Resource Manager

Identity
Summary: Identity
Description: Identity for the resource.

Properties:
Name Type Summary
principalId string The principal id of resource
Principal Id identity.
tenantId string The tenant id of resource.
Tenant Id
type string The identity type. Values:
Type [SystemAssigned]

244 | P a g e
 Azure Resource Manager

Location
Summary:
Description: Location information.

Properties:
Name Type Summary
id string The fully qualified Id of the
Id location. For example,
/subscriptions/00000000-0000-
0000-0000-
000000000000/locations/westus.
subscriptionId string The subscription Id.
Subscription Id
name string The location name.
Location Name
displayName string The display name of the location.
Display Name
latitude string The latitude of the location.
Latitude
longitude string The longitude of the location.
Longitude

245 | P a g e
 Azure Resource Manager

LocationListResult
Summary:
Description: Location list operation response.

Properties:
Name Type Summary
value array of (Location) The locations.

246 | P a g e
 Azure Resource Manager

ParametersLink
Summary:
Description: Entity representing the reference to the deployment paramaters.

Properties:
Name Type Summary
uri string URI referencing the
Parameters URI template.
contentVersion string If included it must match
Parameters Content the ContentVersion in the
Version template.

247 | P a g e
 Azure Resource Manager

Plan
Summary:
Description: Plan for the resource.

Properties:
Name Type Summary
name string The plan ID.
Id
publisher string The publisher ID.
Publisher
product string The offer ID.
Product
promotionCode string The promotion code.
Promotion Code

248 | P a g e
 Azure Resource Manager

Provider
Summary:
Description: Resource provider information.

Properties:
Name Type Summary
id string The provider id.
Id
namespace string The namespace of the
Namespace provider.
registrationState string The registration state of
Registration State the provider.
resourceTypes array of The collection of
(ProviderResourceType) provider resource types.
Resource Type

249 | P a g e
 Azure Resource Manager

ProviderListResult
Summary:
Description: List of resource providers.

Properties:
Name Type Summary
value array of (Provider) The list of resource
providers.
nextLink string The URL to get the next
set of results.

250 | P a g e
 Azure Resource Manager

ProviderResourceType
Summary:
Description: Resource type managed by the resource provider.

Properties:
Name Type Summary
resourceType string The resource type.

locations array of (string) The collection of locations

where this resource type
can be created in.
aliases array of (AliasType) The aliases that are
supported by this
resource type.
apiVersions array of (string) The api version.

properties Properties The properties.

Properties
Summary:
Description: The properties.

Properties:
Name Type Summary

251 | P a g e
 Azure Resource Manager

ResourceGroup
Summary:
Description: Resource group information.

Properties:
Name Type Summary
id string The ID of the resource group (e.g.
Id /subscriptions/XXX/resourceGroups/YYY).
name string The Name of the resource group.
Name
location string The location of the resource group. It
Location cannot be changed after the resource
group has been created. Has to be one of
the supported Azure Locations, such as
West US, East US, West Europe, East Asia,
etc.
managedBy string Id of the resource that manages this
Managed By resource group.
tags Tags The tags attached to the resource group.
Tags
properties ResourceGroupProperties The resource group properties.

Tags
Summary: Tags
Description: The tags attached to the resource group.

Properties:
Name Type Summary

252 | P a g e
Azure Resource Manager

253 | P a g e
 Azure Resource Manager

ResourceGroupExportResult
Summary:
Description:

Properties:
Name Type Summary
template Template The template
Template content.
error ResourceManagementErrorWithDetails

Template
Summary: Template
Description: The template content.

Properties:
Name Type Summary

254 | P a g e
 Azure Resource Manager

ResourceGroupListResult
Summary:
Description: List of resource groups.

Properties:
Name Type Summary
value array of (ResourceGroup) The list of resource
groups.
nextLink string The URL to get the next
Next Link set of results.

255 | P a g e
 Azure Resource Manager

ResourceGroupProperties
Summary:
Description: The resource group properties.

Properties:
Name Type Summary
provisioningState string The provisioning state.
Provisioning State

256 | P a g e
 Azure Resource Manager

ResourceListResult
Summary:
Description: List of resource groups.

Properties:
Name Type Summary
value array of (GenericResource) The list of resources.

nextLink string The URL to get the next

Next Link set of results.

257 | P a g e
 Azure Resource Manager

ResourceManagementErrorWithDetails
Summary:
Description:

Properties:
Name Type Summary
code string The error code
returned from the
server.
message string The error message
returned from the
server.
target string The target of the
error.
details array of Validation error.
(ResourceManagementErrorWithDetails)

258 | P a g e
 Azure Resource Manager

Sku
Summary: SKU
Description: Sku for the resource.

Properties:
Name Type Summary
name string The sku name.
Name
tier string The sku tier.
Tier
size string The sku size.
Size
family string The sku family.
Family
model string The sku model.
Model
capacity integer(int32) The sku capacity.
Capacity

259 | P a g e
 Azure Resource Manager

Subscription
Summary:
Description: Subscription information.

Properties:
Name Type Summary
id string The fully qualified Id. For
Id example,
/subscriptions/00000000-
0000-0000-0000-
000000000000.
subscriptionId string The subscription Id.
Subscription Id
tenantId string The tenant Id.
Tenant Id
displayName string The subscription display
Display Name name.
state string The subscription state.
State Values: [Enabled, Warned,
PastDue, Disabled, Deleted]
subscriptionPolicies SubscriptionPolicies Subscription policies.
Subscription Policies
authorizationSource string The authorization source of
Authorization Source the request. Valid values
are one or more
combinations of Legacy,
RoleBased, Bypassed, Direct
and Management. For

260 | P a g e
 Azure Resource Manager

example, 'Legacy,
RoleBased'.

261 | P a g e
 Azure Resource Manager

SubscriptionListResult
Summary:
Description: Subscription list operation response.

Properties:
Name Type Summary
value array of (Subscription) The subscriptions.

nextLink string The URL to get the next

Next Link set of results.

262 | P a g e
 Azure Resource Manager

SubscriptionPolicies
Summary: Subscription Policies
Description: Subscription policies.

Properties:
Name Type Summary
locationPlacementId string The subscription location
Location Placement Id placement Id. The Id
indicates which regions
are visible for a
subscription. For example,
a subscription with a
location placement Id of
Public_2014-09-01 has
access to Azure public
regions.
quotaId string The subscription quota Id.
Quota Id
spendingLimit string The subscription spending
Spending Limit limit. Values: [On, Off,
CurrentPeriodOff]

263 | P a g e
 Azure Resource Manager

TagCount
Summary: Tag Count
Description: Tag count.

Properties:
Name Type Summary
type string Type of count.
Type
value string Value of count.
Value

264 | P a g e
 Azure Resource Manager

TagDetails
Summary:
Description: Tag details.

Properties:
Name Type Summary
id string The tag ID.
Id
tagName string The tag name.
Name
count TagCount Tag count.
Tag Count
values array of (TagValue) The list of tag values.

265 | P a g e
 Azure Resource Manager

TagsListResult
Summary:
Description: List of subscription tags.

Properties:
Name Type Summary
value array of (TagDetails) The list of tags.

nextLink string The URL to get the next

set of results.

266 | P a g e
 Azure Resource Manager

TagValue
Summary:
Description: Tag information.

Properties:
Name Type Summary
id string The tag ID.
Tag Id
tagValue string The tag value.
Tag Value
count TagCount Tag count.
Tag Count

267 | P a g e
 Azure Resource Manager

TargetResource
Summary: Target Resource
Description: Target resource.

Properties:
Name Type Summary
id string The ID of the resource.
Id
resourceName string The name of the resource.
Name
resourceType string The type of the resource.
Type

268 | P a g e
 Azure Resource Manager

TemplateLink
Summary:
Description: Entity representing the reference to the template.

Properties:
Name Type Summary
uri string URI referencing the
Template URI template.
contentVersion string If included it must match
Template Content the ContentVersion in the
Version template.

269 | P a g e
 Basecamp 2

Basecamp 2
Basecamp 2 keeps people on the same page. No matter what your role is,
everyone works toward a common goal: finishing a project together.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
PostMessage (integer id, Post a message
integer projectId,
CreateMessage_Request
body, [internal]string
Content-Type)
ListToDoLists (integer id, List to-do lists
integer projectId)
ListProjects (integer id) List Projects
ListDocuments (integer id, List Documents
integer projectId)
CreateDocument (integer id, Create Document
integer projectId,
CreateDocument_Request
body, [internal]string
Content-Type)
CreateToDo (integer id, Create a to-do
integer projectId, integer
listId, CreateTo-Do_Request
body, [internal]string
Content-Type)

270 | P a g e
 Basecamp 2

CreateEvent (integer id, Create an event

integer projectId,
CreateEvent_Request body,
[internal]string Content-Type)
ListAccounts () List Accounts

Triggers:
Name Summary
OnDocumentCreated (integer When a document is created
id, integer projectId)
OnToDoCreated (integer id, When a to-do is created
integer projectId, integer
listId, [internal]string Content-
Type)
OnEventCreated (integer id, When an event is created
integer projectId,
[internal]string Content-Type)

Objects:
Name Summary
CreateDocument_Request
CreateDocument_Response
CreateEvent_Request
CreateEvent_Response
CreateMessage_Request
CreateMessage_Response
CreateTo-Do_Request
CreateTo-Do_Response

271 | P a g e
 Basecamp 2

ListAccounts_Response
ListDocumentsResponseItem
ListToDoListsResponseItem

Actions:
PostMessage
Summary: Post a message
Description: Create a new message in a project.

Syntax:
Basecamp2.PostMessage (integer id, integer projectId,
CreateMessage_Request body, [internal]string Content-Type)

Parameters:
Name Type Summary Required Related
Action
id integer True ListAccounts
(Account Id)
projectId integer True ListProjects
(Project Id)
body CreateMessage_Request True

Content-Type string Content True

(Content-Type) type.

Returns:
Type:CreateMessage_Response

272 | P a g e
 Basecamp 2

ListToDoLists
Summary: List to-do lists
Description: List all to-do lists for a project.

Syntax:
Basecamp2.ListToDoLists (integer id, integer projectId)

Parameters:
Name Type Summary Required Related
Action
id integer True ListAccounts
(Account
Id)
projectId integer True ListProjects
(Project Id)

Returns:
Type:array of (ListToDoListsResponseItem)

ListProjects
Summary: List Projects
Description: List all projects for account.

Syntax:
Basecamp2.ListProjects (integer id)

Parameters:

273 | P a g e
 Basecamp 2

Name Type Summary Required Related

Action
id integer True ListAccounts
(Account
Id)

Returns:
Type:array of (ListToDoListsResponseItem)

ListDocuments
Summary: List Documents
Description: List all documents for a project.

Syntax:
Basecamp2.ListDocuments (integer id, integer projectId)

Parameters:
Name Type Summary Required Related
Action
id integer True ListAccounts
(Account
Id)
projectId integer True ListProjects
(Project Id)

Returns:
Type:array of (ListDocumentsResponseItem)

274 | P a g e
 Basecamp 2

CreateDocument
Summary: Create Document
Description: Create a new document.

Syntax:
Basecamp2.CreateDocument (integer id, integer projectId,
CreateDocument_Request body, [internal]string Content-Type)

Parameters:
Name Type Summary Required Related
Action
id integer True ListAccounts
(Account Id)
projectId integer True ListProjects
(Project Id)
body CreateDocument_Request True

Content-Type string Content True

(Content-Type) type.

Returns:
Type:CreateDocument_Response

CreateToDo
Summary: Create a to-do
Description: Add a to-do to a to-do list.

Syntax:

275 | P a g e
 Basecamp 2

Basecamp2.CreateToDo (integer id, integer projectId, integer

listId, CreateTo-Do_Request body, [internal]string Content-Type)

Parameters:
Name Type Summary Required Related
Action
id integer True ListAccounts
(Account Id)
projectId integer True ListProjects
(Project Id)
listId integer True ListToDoLists
(To-Do List
Id)
body CreateTo- True
Do_Request

Content-Type string Content type. True

(Content-
Type)

Returns:
Type:CreateTo-Do_Response

CreateEvent
Summary: Create an event
Description: Create a new scheduled event in a project.

Syntax:

276 | P a g e
 Basecamp 2

Basecamp2.CreateEvent (integer id, integer projectId,

CreateEvent_Request body, [internal]string Content-Type)

Parameters:
Name Type Summary Required Related
Action
id integer True ListAccounts
(Account Id)
projectId integer True ListProjects
(Project Id)
body CreateEvent_Request True

Content-Type string Content True

(Content-Type) type.

Returns:
Type:CreateEvent_Response

ListAccounts
Summary: List Accounts
Description: Get the basecamp accounts for this connection.

Syntax:
Basecamp2.ListAccounts ()

Returns:
Type:ListAccounts_Response

277 | P a g e
 Basecamp 2

Triggers:
Trigger OnDocumentCreated
Summary: When a document is created
Description: Trigger a flow when there is a new document in a project.

Syntax:
Basecamp2.OnDocumentCreated (integer id, integer projectId)

Parameters:
Name Type Summary Required Related
Action
id integer True ListAccounts
(Account
Id)
projectId integer True ListProjects
(Project Id)

Returns:
Type:array of (CreateDocument_Response)

Trigger OnToDoCreated
Summary: When a to-do is created
Description: Trigger a flow when there is a new to-do.

Syntax:
Basecamp2.OnToDoCreated (integer id, integer projectId, integer
listId, [internal]string Content-Type)

Parameters:

278 | P a g e
 Basecamp 2

Name Type Summary Required Related

Action
id integer True ListAccounts
(Account
Id)
projectId integer True ListProjects
(Project Id)
listId integer True ListToDoLists
(To-Do List
Id)
Content-Type string Content type. True
(Content-
Type)

Returns:
Type:array of (CreateTo-Do_Response)

Trigger OnEventCreated
Summary: When an event is created
Description: Trigger a flow when there is a new event.

Syntax:
Basecamp2.OnEventCreated (integer id, integer projectId,
[internal]string Content-Type)

Parameters:
Name Type Summary Required Related
Action
id integer True ListAccounts

279 | P a g e
 Basecamp 2

(Account
Id)
projectId integer True ListProjects
(Project Id)
Content-Type string Content type. True
(Content-
Type)

Returns:
Type:array of (CreateEvent_Response)

280 | P a g e
 Basecamp 2

CreateDocument_Request
Summary:
Description:

Properties:
Name Type Summary
title string The title of the document.
Title
content string The content of the
Content document.

281 | P a g e
 Basecamp 2

CreateDocument_Response
Summary:
Description:

Properties:
Name Type Summary
content string The content of the
Content document.
created_at string(date-time) The datetime the
Created Date document was created at.
id integer(int32) The unique id of the
Id document.
private boolean Whether the document is
Private private.
title string The title of the document.
Title

282 | P a g e
 Basecamp 2

CreateEvent_Request
Summary:
Description:

Properties:
Name Type Summary
summary string The summary of the
Summary event.
description string The description of the
Description event.
starts_at string(date-time) The datetime the event
Start Date starts at.
ends_at string(date-time) The datetime the event
End Date ends at.
remind_at string(date-time) The datetime of the event
Reminder Date reminder.

283 | P a g e
 Basecamp 2

CreateEvent_Response
Summary:
Description:

Properties:
Name Type Summary
all_day boolean Whether the event is all
All Day day.
created_at string(date-time) The datetime the event
Created Date was created at.
description string The description of the
Description event.
ends_at string(date-time) The datetime of event
End Time ends.
id integer(int32) The unique id of the
Id event.
private boolean Whether the event is
Private private.
starts_at string(date-time) The datetime the event
Start Date starts.
summary string The summary of the
Summary event.
url string The URL of the event.
URL

284 | P a g e
 Basecamp 2

CreateMessage_Request
Summary:
Description:

Properties:
Name Type Summary
subject string The subject of the
Subject message.
content string The content of the
Content message.

285 | P a g e
 Basecamp 2

CreateMessage_Response
Summary:
Description:

Properties:
Name Type Summary
content string The content of the
Content message.
created_at string(date-time) The datetime the
Created Date message was created.
id integer(int32) The unique id of the
Id message.
private boolean Whether the message is
Privacy Status private or not.
subject string The subject of the
Subject message.

286 | P a g e
 Basecamp 2

CreateTo-Do_Request
Summary:
Description:

Properties:
Name Type Summary
content string What the to-do is for.
Content
due_at string The datetime the to-do is
Due Date due.

287 | P a g e
 Basecamp 2

CreateTo-Do_Response
Summary:
Description:

Properties:
Name Type Summary
completed boolean Whether the to-do is
Completed completed.
content string What the to-do is for.
Content
created_at string(date-time) The datetime the to-do
Created Date was created.
due_at string(date-time) The datetime the to-do is
Due Date due.
id integer(int32) The unique id of the to-
Id do.
private boolean Whether the to-do is
Private private.
url string The URL of the to-do list.
URL

288 | P a g e
 Basecamp 2

ListAccounts_Response
Summary:
Description:

Properties:
Name Type Summary
accounts array of (AccountsItem)
Account

AccountsItem
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Id of the account.
Id
name string Name of the account.
Name

289 | P a g e
 Basecamp 2

ListDocumentsResponseItem
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) The unique id of the
Id document.
title string The title of the document.
Title

290 | P a g e
 Basecamp 2

ListToDoListsResponseItem
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) The unique id of the to-do
Id list.
name string Name of the to-do list.
Name

291 | P a g e
 Basecamp 3

Basecamp 3
Basecamp 3 is a tool that helps teams work together. It provides a dashboard
to manage all messaging, document collaboration, scheduling and task
management together in one place.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
ListAccounts () List Accounts
ListBasecamps (integer List Basecamps
account_id)
ListToDoLists (integer List to-do lists
account_id, [Optional]string
bucket)
CreateToDo (integer Create a to-do
account_id, string
basecampId, string todolistId,
NewToDo to-do)
ListToDos (integer account_id, List to-dos
string basecampId, string
todolistId)
CompleteToDo (integer Complete a to-do
account_id, string
basecampId, string todoId)
UncompleteToDo (integer Uncomplete a to-do
account_id, string
basecampId, string todoId)

292 | P a g e
 Basecamp 3

DeleteToDo (integer Delete a to-do

account_id, string
basecampId, string todoId)
DeleteScheduledEntry Delete a scheduled entry
(integer account_id, string
basecampId, string eventId)
DeleteDocument (integer Delete a document
account_id, string
basecampId, string
documentId)
PostMessage (integer Post a message
account_id, string
basecampId, NewMessage
message)
ListAllRootFolders (integer Gets the root folder for the file picker
account_id, string
basecampId)
ListFolder (integer List sub folders for file picker
account_id, string
basecampId, string id)
CreateDocument (integer Create a document
account_id, string
basecampId, string vaultId,
NewDocument document)
UploadFile (integer Upload file
account_id, string
basecampId, string vaultId,
string content_type, string
name, string body)

293 | P a g e
 Basecamp 3

CreateScheduleEntry (integer Create a schedule entry

account_id, string
basecampId, NewEntry
scheduleEntry)

Triggers:
Name Summary
OnMessagePosted (integer When a message is posted
account_id, string
basecampId)
OnToDoCreated (integer When a to-do is created
account_id, string
basecampId, string todolistId)
OnToDoUpdated (integer When a to-do is updated
account_id, string
basecampId, string todolistId)
OnDocumentCreated (integer When a document is created
account_id, string
basecampId, string vaultId)
OnDocumentUpdated When a document is updated
(integer account_id, string
basecampId, string vaultId)
OnDocumentDeleted (integer When a document is deleted
account_id, [Optional]string
bucket)
OnScheduledEntryDeleted When a schedule entry is deleted
(integer account_id,
[Optional]string bucket)

294 | P a g e
 Basecamp 3

OnFileUploaded (integer When a file is uploaded

account_id, string
basecampId, string vaultId)
OnFileUpdated (integer When a file is updated
account_id, string
basecampId, string vaultId)
OnScheduledEntryCreated When a schedule entry is created
(integer account_id, string
basecampId)
OnScheduledEntryUpdated When a schedule entry is updated
(integer account_id, string
basecampId)

Objects:
Name Summary
Account
AccountList Accounts
Basecamp
BlobMetaData
DockItem Dock item
Document Document
Entry Schedule entry
Message Message
NewDocument New document
NewEntry New schedule entry
NewMessage New message
NewToDo To-do
OnDocumentCreatedResponseItem Document

295 | P a g e
 Basecamp 3

OnFileUploadedResponseItem Upload
OnMessagePostedResponseItem Message
OnScheduledEntryDeletedResponseItem Schedule entry
OnToDoCreatedResponseItem To-do
ToDo To-do
ToDoList To-do list

Actions:
ListAccounts
Summary: List Accounts
Description: List Accounts you're a part of

Syntax:
Basecamp3.ListAccounts ()

Returns:
Type:AccountList
Summary: Accounts
Description: A list of Accounts

ListBasecamps
Summary: List Basecamps
Description: List Basecamps you're a part of

Syntax:
Basecamp3.ListBasecamps (integer account_id)

Parameters:

296 | P a g e
 Basecamp 3

Name Type Summary Required Related

Action
account_id integer True ListAccounts
(Account
Id)

Returns:
Type:array of (Basecamp)
Summary: Basecamps
Description: A list of Basecamps

ListToDoLists
Summary: List to-do lists
Description: List the to-do lists in the basecamp

Syntax:
Basecamp3.ListToDoLists (integer account_id, [Optional]string
bucket)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
bucket string Basecamp to False ListBasecamps
(Basecamp) filter on

Returns:

297 | P a g e
 Basecamp 3

Type:array of (ToDoList)
Summary: To-do lists
Description: The to-do lists in the Basecamp

CreateToDo
Summary: Create a to-do
Description: Add a to-do to a to-do list

Syntax:
Basecamp3.CreateToDo (integer account_id, string basecampId,
string todolistId, NewToDo to-do)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
basecampId string True ListBasecamps
(Basecamp)
todolistId string True ListToDoLists
(To-do list)
to-do NewToDo A To-do in a True
(To-do) To-do List

Returns:
Type:ToDo
Summary: To-do
Description: A To-do from a To-do List

298 | P a g e
 Basecamp 3

ListToDos
Summary: List to-dos
Description: List the to-dos in a to-do list

Syntax:
Basecamp3.ListToDos (integer account_id, string basecampId,
string todolistId)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
basecampId string True ListBasecamps
(Basecamp)
todolistId string True ListToDoLists
(To-do list)

Returns:
Type:array of (ToDo)
Summary: To-dos
Description: The top 50 active items in the to-do list

CompleteToDo
Summary: Complete a to-do
Description: Mark a to-do as completed

299 | P a g e
 Basecamp 3

Syntax:
Basecamp3.CompleteToDo (integer account_id, string basecampId,
string todoId)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
basecampId string True ListBasecamps
(Basecamp)
todoId string Get a To-do Id True
(To-do Id) from a
previous step

Returns:

UncompleteToDo
Summary: Uncomplete a to-do
Description: Mark a to-do as not completed

Syntax:
Basecamp3.UncompleteToDo (integer account_id, string basecampId,
string todoId)

Parameters:
Name Type Summary Required Related
Action

300 | P a g e
 Basecamp 3

account_id integer True ListAccounts

(Account
Id)
basecampId string True ListBasecamps
(Basecamp)
todoId string Get a To-do Id True
(To-do Id) from a
previous step

Returns:

DeleteToDo
Summary: Delete a to-do
Description: Put a to-do in the trash

Syntax:
Basecamp3.DeleteToDo (integer account_id, string basecampId,
string todoId)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
basecampId string True ListBasecamps
(Basecamp)

301 | P a g e
 Basecamp 3

todoId string Get a To-do Id True

(To-do Id) from a
previous step

Returns:

DeleteScheduledEntry
Summary: Delete a scheduled entry
Description: Put a scheduled entry in the trash

Syntax:
Basecamp3.DeleteScheduledEntry (integer account_id, string
basecampId, string eventId)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
basecampId string True ListBasecamps
(Basecamp)
eventId string Get a True
(Scheduled scheduled
entry Id) entry Id from a
previous step

Returns:

302 | P a g e
 Basecamp 3

DeleteDocument
Summary: Delete a document
Description: Put a document in the trash

Syntax:
Basecamp3.DeleteDocument (integer account_id, string basecampId,
string documentId)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
basecampId string True ListBasecamps
(Basecamp)
documentId string Get a True
(Document document Id
Id) from a
previous step

Returns:

PostMessage
Summary: Post a message
Description: Add a message to a basecamp

Syntax:

303 | P a g e
 Basecamp 3

Basecamp3.PostMessage (integer account_id, string basecampId,

NewMessage message)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account Id)
basecampId string True ListBasecamps
(Basecamp)
message NewMessage A message to True
(New post to a
message) basecamp

Returns:
Type:Message
Summary: Message
Description: A message posted to a basecamp

ListAllRootFolders
Summary: Gets the root folder for the file picker
Description: Gets the root folder for the file picker

Syntax:
Basecamp3.ListAllRootFolders (integer account_id, string
basecampId)

Parameters:

304 | P a g e
 Basecamp 3

Name Type Summary Required Related

Action
account_id integer True ListAccounts
(Account
Id)
basecampId string True ListBasecamps
(Basecamp)

Returns:
Type:array of (BlobMetaData)

ListFolder
Summary: List sub folders for file picker
Description: List sub folders for file picker

Syntax:
Basecamp3.ListFolder (integer account_id, string basecampId,
string id)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
basecampId string True ListBasecamps
(Basecamp)
id string The id of the True
parent folder

305 | P a g e
 Basecamp 3

(Root
Folder)

Returns:
Type:array of (BlobMetaData)

CreateDocument
Summary: Create a document
Description: Add a document

Syntax:
Basecamp3.CreateDocument (integer account_id, string basecampId,
string vaultId, NewDocument document)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account Id)
basecampId string True ListBasecamps
(Basecamp)
vaultId string Select a folder True
(Vault (folder)) or enter a
vault Id
document NewDocument A new True
(New document
document)

Returns:

306 | P a g e
 Basecamp 3

Type:Document
Summary: Document
Description: A document object

UploadFile
Summary: Upload file
Description: Upload a file

Syntax:
Basecamp3.UploadFile (integer account_id, string basecampId,
string vaultId, string content_type, string name, string body)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account Id)
basecampId string True ListBasecamps
(Basecamp)
vaultId string Select a folder True
(Vault or enter a
(folder)) vault Id
content_type string The content True
(Content type of the file
type)
name string Name of the True
(File name) file being
uploaded
body string(binary) True

307 | P a g e
 Basecamp 3

Returns:
Type:array of (Basecamp)
Summary: Basecamps
Description: A list of Basecamps

CreateScheduleEntry
Summary: Create a schedule entry
Description: Create a schedule entry

Syntax:
Basecamp3.CreateScheduleEntry (integer account_id, string
basecampId, NewEntry scheduleEntry)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
basecampId string True ListBasecamps
(Basecamp)
scheduleEntry NewEntry An entry to True
(New schedule
schedule
entry)

Returns:

308 | P a g e
 Basecamp 3

Type:Entry
Summary: Schedule entry
Description: An entry to schedule

Triggers:
Trigger OnMessagePosted
Summary: When a message is posted
Description:

Syntax:
Basecamp3.OnMessagePosted (integer account_id, string
basecampId)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
basecampId string True ListBasecamps
(Basecamp)

Returns:
Type:array of (OnMessagePostedResponseItem)

Trigger OnToDoCreated
Summary: When a to-do is created
Description:

309 | P a g e
 Basecamp 3

Syntax:
Basecamp3.OnToDoCreated (integer account_id, string basecampId,
string todolistId)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
basecampId string True ListBasecamps
(Basecamp)
todolistId string True ListToDoLists
(To-do list)

Returns:
Type:array of (OnToDoCreatedResponseItem)

Trigger OnToDoUpdated
Summary: When a to-do is updated
Description:

Syntax:
Basecamp3.OnToDoUpdated (integer account_id, string basecampId,
string todolistId)

Parameters:
Name Type Summary Required Related
Action

310 | P a g e
 Basecamp 3

account_id integer True ListAccounts

(Account
Id)
basecampId string True ListBasecamps
(Basecamp)
todolistId string True ListToDoLists
(To-do list)

Returns:
Type:array of (OnToDoCreatedResponseItem)

Trigger OnDocumentCreated
Summary: When a document is created
Description:

Syntax:
Basecamp3.OnDocumentCreated (integer account_id, string
basecampId, string vaultId)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
basecampId string True ListBasecamps
(Basecamp)

311 | P a g e
 Basecamp 3

vaultId string Select a folder True

(Vault or enter a vault
(folder)) Id

Returns:
Type:array of (OnDocumentCreatedResponseItem)

Trigger OnDocumentUpdated
Summary: When a document is updated
Description:

Syntax:
Basecamp3.OnDocumentUpdated (integer account_id, string
basecampId, string vaultId)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
basecampId string True ListBasecamps
(Basecamp)
vaultId string Select a folder True
(Vault or enter a vault
(folder)) Id

Returns:
Type:array of (OnDocumentCreatedResponseItem)

312 | P a g e
 Basecamp 3

Trigger OnDocumentDeleted
Summary: When a document is deleted
Description:

Syntax:
Basecamp3.OnDocumentDeleted (integer account_id,
[Optional]string bucket)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
bucket string Basecamp to False ListBasecamps
(Basecamp) filter on

Returns:
Type:array of (OnDocumentCreatedResponseItem)

Trigger OnScheduledEntryDeleted
Summary: When a schedule entry is deleted
Description:

Syntax:
Basecamp3.OnScheduledEntryDeleted (integer account_id,
[Optional]string bucket)

313 | P a g e
 Basecamp 3

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
bucket string Basecamp to False ListBasecamps
(Basecamp) filter on

Returns:
Type:array of (OnScheduledEntryDeletedResponseItem)

Trigger OnFileUploaded
Summary: When a file is uploaded
Description:

Syntax:
Basecamp3.OnFileUploaded (integer account_id, string basecampId,
string vaultId)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
basecampId string True ListBasecamps
(Basecamp)

314 | P a g e
 Basecamp 3

vaultId string Select a folder True

(Vault or enter a vault
(folder)) Id

Returns:
Type:array of (OnFileUploadedResponseItem)

Trigger OnFileUpdated
Summary: When a file is updated
Description:

Syntax:
Basecamp3.OnFileUpdated (integer account_id, string basecampId,
string vaultId)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
basecampId string True ListBasecamps
(Basecamp)
vaultId string Select a folder True
(Vault or enter a vault
(folder)) Id

Returns:
Type:array of (OnFileUploadedResponseItem)

315 | P a g e
 Basecamp 3

Trigger OnScheduledEntryCreated
Summary: When a schedule entry is created
Description:

Syntax:
Basecamp3.OnScheduledEntryCreated (integer account_id, string
basecampId)

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
basecampId string True ListBasecamps
(Basecamp)

Returns:
Type:array of (OnScheduledEntryDeletedResponseItem)

Trigger OnScheduledEntryUpdated
Summary: When a schedule entry is updated
Description:

Syntax:
Basecamp3.OnScheduledEntryUpdated (integer account_id, string
basecampId)

316 | P a g e
 Basecamp 3

Parameters:
Name Type Summary Required Related
Action
account_id integer True ListAccounts
(Account
Id)
basecampId string True ListBasecamps
(Basecamp)

Returns:
Type:array of (OnScheduledEntryDeletedResponseItem)

317 | P a g e
 Basecamp 3

Account
Summary:
Description: A Basecamp account

Properties:
Name Type Summary
id integer Unique identifier of the
Id the Account
name string The name of the the
Name Account
product string Identifies which Basecamp
Product product the account is
part of
href string The URL of the Account
URL

318 | P a g e
 Basecamp 3

AccountList
Summary: Accounts
Description: A list of Accounts

Properties:
Name Type Summary
accounts array of (Account) All accounts you're a part
Accounts of

319 | P a g e
 Basecamp 3

Basecamp
Summary:
Description: A Basecamp

Properties:
Name Type Summary
id integer Unique identifier of the
Id the Basecamp
status string The status of the
Status Basecamp
name string The name of the the
Name Basecamp
bookmark_url string The API URL at which to
Bookmark URL change bookmark status
app_url string A link to the basecamp
Web URL
bookmarked boolean Whether or not this
Bookmarked basecamp is bookmarked
dock Dock The tools available in this
Dock Basecamp

Dock
Summary: Dock
Description: The tools available in this Basecamp

Properties:
Name Type Summary
chat DockItem A tool in a Basecamp's
Dock item dock

320 | P a g e
 Basecamp 3

message_board DockItem A tool in a Basecamp's

Dock item dock
todoset DockItem A tool in a Basecamp's
Dock item dock
schedule DockItem A tool in a Basecamp's
Dock item dock
questionnaire DockItem A tool in a Basecamp's
Dock item dock
vault DockItem A tool in a Basecamp's
Dock item dock

321 | P a g e
 Basecamp 3

BlobMetaData
Summary:
Description: Metadata for document Blobs

Properties:
Name Type Summary
Id string The unique identifier for
Id the file or folder
Name string The name of the file or
Name folder
DisplayName string The display name of the
Name file or folder
Path string The path of the file or
Path folder
LastModified string(date-time) The last modified date of
Name the file or folder
Size integer(int64) The size of the file or
Size folder
MediaType string The MIME media type of
Media Type the file
IsFolder boolean Indicates whether the
Is Folder item is a folder
ETag string The ETag, a token used
ETag for syncing
FileLocator string The file locator (unknown
File locator use)

322 | P a g e
 Basecamp 3

DockItem
Summary: Dock item
Description: A tool in a Basecamp's dock

Properties:
Name Type Summary
id integer Unique identifier of the
Id the dock item
title string The title of the the dock
Title item
name string The name of the the dock
Name item
enabled boolean Whether or not this item
Enaled is available to use
position number This item's order in the
Position dock
app_url string A link to the specific item
Web URL in the Basecamp

323 | P a g e
 Basecamp 3

Document
Summary: Document
Description: A document object

Properties:
Name Type Summary
title string The title of the document
Title
content string The content of the
Content document, formatted as
HTML
app_url string A link to the document
URL
id integer The unique Id of the
Id document
created_at string(date-time) The date the document
Created date was created
updated_at string(date-time) The date the document
Updated date was updated
vault_id string
Vault Id
vault_title string
Vault Title
vault_url string
Vault Url

324 | P a g e
 Basecamp 3

Entry
Summary: Schedule entry
Description: An entry to schedule

Properties:
Name Type Summary
summary string A summarized description
Summary of the schedule entry
starts_at string(date-time) Time format: yyyy-MM-
Start time ddTHH:mm:ss.fffZ (2016-
07-20T08:00:59.000Z)
ends_at string(date-time) Time format: yyyy-MM-
End time ddTHH:mm:ss.fffZ (2016-
07-20T08:00:59.000Z)
app_url string A link to the document
URL
id integer The unique Id of the
Id document
created_at string(date-time) The date the entry was
Created date created
updated_at string(date-time) The date the entry was
Updated date updated

325 | P a g e
 Basecamp 3

Message
Summary: Message
Description: A message posted to a basecamp

Properties:
Name Type Summary
subject string The subject of the
Subject message
content string The content of the
Content message, formatted as
HTML
url string A link to the message
URL
id integer The unique Id of the
Id message
created_at string(date-time) The date the message was
Created date posted
updated_at string(date-time) The date the message was
Updated date updated

326 | P a g e
 Basecamp 3

NewDocument
Summary: New document
Description: A new document

Properties:
Name Type Summary
title string The title of the document
Title
content string The content of the
Content document, formatted as
HTML

327 | P a g e
 Basecamp 3

NewEntry
Summary: New schedule entry
Description: An entry to schedule

Properties:
Name Type Summary
summary string A summarized description
Summary of the schedule entry
starts_at string(date-time) Time format: yyyy-MM-
Start time ddTHH:mm:ss.fffZ (2016-
07-20T08:00:59.000Z)
ends_at string(date-time) Time format: yyyy-MM-
End time ddTHH:mm:ss.fffZ (2016-
07-20T08:00:59.000Z)
participant_ids string A comma separated list of
Participants participant email addresses

328 | P a g e
 Basecamp 3

NewMessage
Summary: New message
Description: A message to post to a basecamp

Properties:
Name Type Summary
subject string The subject of the
Subject message
content string The content of the
Content message, formatted as
HTML

329 | P a g e
 Basecamp 3

NewToDo
Summary: To-do
Description: A To-do in a To-do List

Properties:
Name Type Summary
content string What the to-do is for
Content
description string A description of the to-do,
Description formatted as HTML
due_on string(date-time) A due date when the to-
Due on do should be completed
start_on string(date-time) A date when the to-do
Start on should be started

330 | P a g e
 Basecamp 3

OnDocumentCreatedResponseItem
Summary: Document
Description: A document object

Properties:
Name Type Summary
title string The title of the document
Title
content string The content of the
Content document, formatted as
HTML
app_url string A link to the document
URL
id integer The unique Id of the
Id document
created_at string(date-time) The date the document
Created date was created
updated_at string(date-time) The date the document
Updated date was updated
vault_id string
Vault Id
vault_title string
Vault Title
vault_url string
Vault Url

331 | P a g e
 Basecamp 3

OnFileUploadedResponseItem
Summary: Upload
Description: A file upload object

Properties:
Name Type Summary
filename string The file name of the
File name upload
description string The description of the
Description uploaded file
app_url string A link to the file
URL
id integer The unique Id of the file
Id
created_at string(date-time) The date the file was
Created date uploaded
updated_at string(date-time) The date the file was
Updated date updated
content_type string The content type of the
Content type file
byte_size integer The size in bytes of the
Size uploaded file

332 | P a g e
 Basecamp 3

OnMessagePostedResponseItem
Summary: Message
Description: A message posted to a basecamp

Properties:
Name Type Summary
subject string The subject of the
Subject message
content string The content of the
Content message, formatted as
HTML
url string A link to the message
URL
id integer The unique Id of the
Id message
created_at string(date-time) The date the message was
Created date posted
updated_at string(date-time) The date the message was
Updated date updated

333 | P a g e
 Basecamp 3

OnScheduledEntryDeletedResponseItem
Summary: Schedule entry
Description: An entry to schedule

Properties:
Name Type Summary
summary string A summarized description
Summary of the schedule entry
starts_at string(date-time) Time format: yyyy-MM-
Start time ddTHH:mm:ss.fffZ (2016-
07-20T08:00:59.000Z)
ends_at string(date-time) Time format: yyyy-MM-
End time ddTHH:mm:ss.fffZ (2016-
07-20T08:00:59.000Z)
app_url string A link to the document
URL
id integer The unique Id of the
Id document
created_at string(date-time) The date the entry was
Created date created
updated_at string(date-time) The date the entry was
Updated date updated

334 | P a g e
 Basecamp 3

OnToDoCreatedResponseItem
Summary: To-do
Description: A To-do from a To-do List

Properties:
Name Type Summary
id integer Unique identifier of the
Id the to-do
content string What the to-do is for
Content
description string A description of the to-do,
Description formatted as HTML
due_on string(date-time) A due date when the to-
Due on do should be completed
start_on string(date-time) A date when the to-do
Start on should be started

335 | P a g e
 Basecamp 3

ToDo
Summary: To-do
Description: A To-do from a To-do List

Properties:
Name Type Summary
id integer Unique identifier of the
Id the to-do
content string What the to-do is for
Content
description string A description of the to-do,
Description formatted as HTML
due_on string(date-time) A due date when the to-
Due on do should be completed
start_on string(date-time) A date when the to-do
Start on should be started

336 | P a g e
 Basecamp 3

ToDoList
Summary: To-do list
Description: A To-do list

Properties:
Name Type Summary
id integer Unique identifier of the
Id the to-do list
name string The name of the the to-do
Name list
description string A description of the to-do
Description list, formatted as HTML
completed boolean Whether or not all items
Completed in this to-do list are
completed

337 | P a g e
 Bitbucket

Bitbucket
Bitbucket is a web based hosting service for projects that use GIT revision
control.

Status: Preview Tier: Premium Version: 1.0.0

Actions:
Name Summary
DeleteHook (string account, Delete hook
string slug, string hookId)
ListComponents (string List components
account, string slug)
ListMilestones (string List milestones
account, string slug)
ListVersions (string account, List versions
string slug)
CreateIssue (string account, Create issue
string slug,
CreateIssueRequest body)
GetIssueById (string account, Get issue by id
string slug, string issueId)
ListPullRequests (string List pull requests
account, string slug)
ApprovePullRequest (string Approve pull request
account, string slug, string
pullrequestId)

338 | P a g e
 Bitbucket

DeclinePullRequest (string Decline pull request

account, string slug, string
pullrequestId)
MergePullRequest (string Merge pull request
account, string slug, string
pullrequestId)
ListRepositories (string List repositories
account)
GetUserById (string userId) Get user by Id

Triggers:
Name Summary
OnNewRepo (string account) When a repository is added
CreateHookIssueCreated (string When a new issue is added
account, string slug,
[Optional]WebhookRequest
body)
CreateHookIssueUpdated (string When an issue is updated
account, string slug,
[Optional]WebhookRequest
body)
CreateHookPullRequestApproved When a pull request is approved
(string account, string slug,
[Optional]WebhookRequest
body)
CreateHookPullRequestCreated When a pull request is created
(string account, string slug,

339 | P a g e
 Bitbucket

[Optional]WebhookRequest
body)
CreateHookPullRequestDeclined When a pull request is declined
(string account, string slug,
[Optional]WebhookRequest
body)
CreateHookPullRequestMerged When a pull request is merged
(string account, string slug,
[Optional]WebhookRequest
body)
CreateHookRepositoryPush When a new commit is pushed
(string account, string slug,
[Optional]WebhookRequest
body)

Objects:
Name Summary
ApprovePullRequestResponse
CreateIssueRequest
DeclineOrMergePullRequestResponse
IssueResponse
ListComponentMilestoneVersionResponse
List_pull_requests_Response
List_repositories_Response
UserResponse
WebhookRequest

340 | P a g e
 Bitbucket

Actions:
DeleteHook
Summary: Delete hook
Description: Delete a hook in a given repo.

Syntax:
Bitbucket.DeleteHook (string account, string slug, string
hookId)

Parameters:
Name Type Summary Required Related Action
account string Atlassian True
(Account account or
Name) team name
slug string Bitbucket True ListRepositories
(Repository repository
Id)
hookId string True

Returns:

ListComponents
Summary: List components
Description: List components

Syntax:
Bitbucket.ListComponents (string account, string slug)

341 | P a g e
 Bitbucket

Parameters:
Name Type Summary Required Related Action
account string Atlassian True
(Account account or
Name) team name
slug string Bitbucket True ListRepositories
(Repository repository
Id)

Returns:
Type:ListComponentMilestoneVersionResponse

ListMilestones
Summary: List milestones
Description: List milestones

Syntax:
Bitbucket.ListMilestones (string account, string slug)

Parameters:
Name Type Summary Required Related Action
account string Atlassian True
(Account account or
Name) team name
slug string Bitbucket True ListRepositories
(Repository repository
Id)

Returns:

342 | P a g e
 Bitbucket

Type:ListComponentMilestoneVersionResponse

ListVersions
Summary: List versions
Description: List versions

Syntax:
Bitbucket.ListVersions (string account, string slug)

Parameters:
Name Type Summary Required Related Action
account string Atlassian True
(Account account or
Name) team name
slug string Bitbucket True ListRepositories
(Repository repository
Id)

Returns:
Type:ListComponentMilestoneVersionResponse

CreateIssue
Summary: Create issue
Description: This operation creates a new issue in the given repository.

Syntax:
Bitbucket.CreateIssue (string account, string slug,
CreateIssueRequest body)

343 | P a g e
 Bitbucket

Parameters:
Name Type Summary Required Related Action
account string Atlassian True
(Account Name) account or
team name
slug string Bitbucket True ListRepositories
(Repository Id) repository
body CreateIssueRequest True

Returns:
Type:IssueResponse

GetIssueById
Summary: Get issue by id
Description: This operation retrieves all information about the given issue.

Syntax:
Bitbucket.GetIssueById (string account, string slug, string
issueId)

Parameters:
Name Type Summary Required Related Action
account string Atlassian True
(Account account or
Name) team name
slug string Bitbucket True ListRepositories
(Repository repository
Id)

344 | P a g e
 Bitbucket

issueId string True

(Issue Id)

Returns:
Type:IssueResponse

ListPullRequests
Summary: List pull requests
Description: This operation returns a list of the last 100 pull requests for the given
repo.

Syntax:
Bitbucket.ListPullRequests (string account, string slug)

Parameters:
Name Type Summary Required Related Action
account string Atlassian True
(Account account or
Name) team name
slug string Bitbucket True ListRepositories
(Repository repository
Id)

Returns:
Type:List_pull_requests_Response

ApprovePullRequest
Summary: Approve pull request
Description: This operation is used to approve an existing pull request.

345 | P a g e
 Bitbucket

Syntax:
Bitbucket.ApprovePullRequest (string account, string slug,
string pullrequestId)

Parameters:
Name Type Summary Required Related Action
account string Atlassian True
(Account account or
Name) team name
slug string Bitbucket True ListRepositories
(Repository repository
Id)
pullrequestId string True ListPullRequests
(Pull
Request Id)

Returns:
Type:ApprovePullRequestResponse

DeclinePullRequest
Summary: Decline pull request
Description: This operation is used to decline an existing pull request.

Syntax:
Bitbucket.DeclinePullRequest (string account, string slug,
string pullrequestId)

Parameters:

346 | P a g e
 Bitbucket

Name Type Summary Required Related Action

account string Atlassian True
(Account account or
Name) team name
slug string Bitbucket True ListRepositories
(Repository repository
Id)
pullrequestId string True ListPullRequests
(Pull
Request Id)

Returns:
Type:DeclineOrMergePullRequestResponse

MergePullRequest
Summary: Merge pull request
Description: This operation can merge a given pull request.

Syntax:
Bitbucket.MergePullRequest (string account, string slug, string
pullrequestId)

Parameters:
Name Type Summary Required Related Action
account string Atlassian True
(Account account or
Name) team name
slug string Bitbucket True ListRepositories
repository

347 | P a g e
 Bitbucket

(Repository
Id)
pullrequestId string True ListPullRequests
(Pull
Request Id)

Returns:
Type:DeclineOrMergePullRequestResponse

ListRepositories
Summary: List repositories
Description: This operation returns a list of all repositories in your account

Syntax:
Bitbucket.ListRepositories (string account)

Parameters:
Name Type Summary Required Related
Action
account string Atlassian True
(Account account or team
Name) name

Returns:
Type:List_repositories_Response

GetUserById
Summary: Get user by Id
Description: This operation returns all information about a given user by its id.

348 | P a g e
 Bitbucket

Syntax:
Bitbucket.GetUserById (string userId)

Parameters:
Name Type Summary Required Related
Action
userId string True
(User Id)

Returns:
Type:UserResponse

Triggers:
Trigger OnNewRepo
Summary: When a repository is added
Description: Triggers when a new repository is created for the authenticated account.

Syntax:
Bitbucket.OnNewRepo (string account)

Parameters:
Name Type Summary Required Related
Action
account string Atlassian True
(Account account or team
Name) name

Returns:
349 | P a g e
 Bitbucket

Type:List_repositories_Response

Trigger CreateHookIssueCreated
Summary: When a new issue is added
Description: Triggers when a new issue is added to the given repository.

Syntax:
Bitbucket.CreateHookIssueCreated (string account, string slug,
[Optional]WebhookRequest body)

Parameters:
Name Type Summary Required Related Action
account string Atlassian True
(Account Name) account or
team name
slug string Bitbucket True ListRepositories
(Repository Id) repository
body WebhookRequest False

Returns:
Type:string

Trigger CreateHookIssueUpdated
Summary: When an issue is updated
Description: Triggers when an issue is updated in the given repository.

Syntax:

350 | P a g e
 Bitbucket

Bitbucket.CreateHookIssueUpdated (string account, string slug,

[Optional]WebhookRequest body)

Parameters:
Name Type Summary Required Related Action
account string Atlassian True
(Account Name) account or
team name
slug string Bitbucket True ListRepositories
(Repository Id) repository
body WebhookRequest False

Returns:
Type:string

Trigger CreateHookPullRequestApproved
Summary: When a pull request is approved
Description: Triggers when a pullreqest is approved in the specified repository.

Syntax:
Bitbucket.CreateHookPullRequestApproved (string account, string
slug, [Optional]WebhookRequest body)

Parameters:
Name Type Summary Required Related Action
account string Atlassian True
(Account Name) account or
team name

351 | P a g e
 Bitbucket

slug string Bitbucket True ListRepositories

(Repository Id) repository
body WebhookRequest False

Returns:
Type:string

Trigger CreateHookPullRequestCreated
Summary: When a pull request is created
Description: Triggers when a new pullreqest is created in the given repository.

Syntax:
Bitbucket.CreateHookPullRequestCreated (string account, string
slug, [Optional]WebhookRequest body)

Parameters:
Name Type Summary Required Related Action
account string Atlassian True
(Account Name) account or
team name
slug string Bitbucket True ListRepositories
(Repository Id) repository
body WebhookRequest False

Returns:
Type:string

352 | P a g e
 Bitbucket

Trigger CreateHookPullRequestDeclined
Summary: When a pull request is declined
Description: Triggers when an existing pullreqest is declined in the given repository.

Syntax:
Bitbucket.CreateHookPullRequestDeclined (string account, string
slug, [Optional]WebhookRequest body)

Parameters:
Name Type Summary Required Related Action
account string Atlassian True
(Account Name) account or
team name
slug string Bitbucket True ListRepositories
(Repository Id) repository
body WebhookRequest False

Returns:
Type:string

Trigger CreateHookPullRequestMerged
Summary: When a pull request is merged
Description: Triggers when an existing pullreqest is merged in the given repository.

Syntax:
Bitbucket.CreateHookPullRequestMerged (string account, string
slug, [Optional]WebhookRequest body)

353 | P a g e
 Bitbucket

Parameters:
Name Type Summary Required Related Action
account string Atlassian True
(Account Name) account or
team name
slug string Bitbucket True ListRepositories
(Repository Id) repository
body WebhookRequest False

Returns:
Type:string

Trigger CreateHookRepositoryPush
Summary: When a new commit is pushed
Description: Triggers when a new commit is pushed to the given repository.

Syntax:
Bitbucket.CreateHookRepositoryPush (string account, string slug,
[Optional]WebhookRequest body)

Parameters:
Name Type Summary Required Related Action
account string Atlassian True
(Account Name) account or
team name
slug string Bitbucket True ListRepositories
(Repository Id) repository
body WebhookRequest False

354 | P a g e
 Bitbucket

Returns:
Type:string

355 | P a g e
 Bitbucket

ApprovePullRequestResponse
Summary:
Description:

Properties:
Name Type Summary
role string The role of the pull
Role request.
type string The type of the pull
Type request.
user User user
Approver
approved boolean True if the pull request is
Is approved approved.

User
Summary: Approver
Description: user

Properties:
Name Type Summary
username string The username of the
Username approver.
display_name string The display name of the
Name approver.
type string User or team.
Type
uuid string The universally unique
UUID identifier of the user.

356 | P a g e
 Bitbucket

357 | P a g e
 Bitbucket

CreateIssueRequest
Summary:
Description:

Properties:
Name Type Summary
title string
Issue Title
content Content The description of the
issue.
kind string Values: [bug,
Issue Type enhancement, proposal,
task]
priority string The priority category of
Priority the issue. Values: [trivial,
minor, major, critical,
blocker]
status string Values: [new, open,
Status resolved, on hold, invalid,
duplicate, wontfix]
component Component

milestone Milestone

version Version

Content
Summary:

358 | P a g e
 Bitbucket

Description: The description of the issue.

Properties:
Name Type Summary
raw string
Description
markup string markup
markup

Component
Summary:
Description:

Properties:
Name Type Summary
name string Pre-defined component
Component value.

Milestone
Summary:
Description:

Properties:
Name Type Summary
name string Pre-defined milestone
Milestone value.

Version
Summary:

359 | P a g e
 Bitbucket

Description:

Properties:
Name Type Summary
name string Pre-defined version value.
Version

360 | P a g e
 Bitbucket

DeclineOrMergePullRequestResponse
Summary:
Description:

Properties:
Name Type Summary
merge_commit Merge_commit merge_commit
merge_commit
description string Pull request description.
Description
title string Pull request title.
Title
destination Destination Destination branch.
Destination
state string Pull request status.
Status
closed_by Closed_by

source Source
Source
author Author Author
Author
created_on string(date-time) yyyy-MM-
Created Date-Time ddTHH:mm:ss.fff(+hh:mm
or -hh:mm)
reason string The reason the pull request
Reason is declined (if so).

361 | P a g e
 Bitbucket

updated_on string yyyy-MM-

Updated on ddTHH:mm:ss.fff(+hh:mm
or -hh:mm)
id integer(int32) The Id of the pull request.
Id
task_count integer(int32) Task count.
Task Count

Merge_commit
Summary: merge_commit
Description: merge_commit

Properties:
Name Type Summary
hash string hash
hash

Destination
Summary: Destination
Description: Destination branch.

Properties:
Name Type Summary
branch Branch branch
Branch
commit Commit
Commit
repository Repository
Repository

362 | P a g e
 Bitbucket

Branch
Summary: Branch
Description: branch

Properties:
Name Type Summary
name string The name of the
Name destination branch.

Commit
Summary: Commit
Description:

Properties:
Name Type Summary
hash string The SHA1 of the
Hash destination branch head.

Repository
Summary: Repository
Description:

Properties:
Name Type Summary
name string The name of the
Name destination branch
repository.

363 | P a g e
 Bitbucket

uuid string The UUID of the

UUID destination branch
repository.
type string The type of the destination
Type branch repository.

Closed_by
Summary:
Description:

Properties:
Name Type Summary
username string Username of person who
Closed By Username closed the PR.
display_name string Name of person who
Closed By Name closed the PR.
type string Closed by a user or team.
User Type
uuid string Unique identifier of
UUID person who closed the PR.

Source
Summary: Source
Description:

Properties:
Name Type Summary
branch Branch
Branch

364 | P a g e
 Bitbucket

commit Commit Commit

Commit
repository Repository Repository
Repository

Branch
Summary: Branch
Description:

Properties:
Name Type Summary
name string Name of the source
Name branch.

Commit
Summary: Commit
Description: Commit

Properties:
Name Type Summary
hash string The SHA1 of the source
Hash branch head.

Repository
Summary: Repository
Description: Repository

Properties:

365 | P a g e
 Bitbucket

Name Type Summary

name string The name of the source
Name branch repository.
uuid string The UUID of the source
UUID branch repository.
type string The type of the source
Type branch repository.

Author
Summary: Author
Description: Author

Properties:
Name Type Summary
display_name string The display name of the
Name creator.
type string The type of the creator.
Type
username string The username of the
Username creator
uuid string The universally unique
UUID identifier of the creator.

366 | P a g e
 Bitbucket

IssueResponse
Summary:
Description:

Properties:
Name Type Summary
priority string The priority of the issue.
Priority
kind string The kind of issue.
Kind
repository Repository
Repository
reporter Reporter
Reporter
title string The title of the issue.
Title
component Component

votes integer(int32) The number of votes on the

Votes issue.
watches integer(int32) The number of watches on
Watches the issue.
content Content
Description
assignee string The assigned user of the
Assignee issue.
state string The status of the issue.
Status
version Version

367 | P a g e
 Bitbucket

created_on string(date-time) yyyy-MM-

Created on ddTHH:mm:ss.fff(+hh:mm or
-hh:mm)
milestone Milestone

updated_on string(date-time) yyyy-MM-

Updated on ddTHH:mm:ss.fff(+hh:mm or
-hh:mm)
type string The type of issue.
Type
id integer(int32) The Id of the issue.
Issue Id

Repository
Summary: Repository
Description:

Properties:
Name Type Summary
type string The type of the repository.
type
name string The name of the
name repository.
full_name string The full name of the
full name repository.
uuid string The Universally Unique
UUID Identifier of the
repository.

368 | P a g e
 Bitbucket

Reporter
Summary: Reporter
Description:

Properties:
Name Type Summary
username string The username of the
Username reporter.
display_name string The display name of the
Display name reporter.
type string The type of the reporter.
Type
uuid string The Universally Unique
UUID Identifier of the reporter.

Component
Summary:
Description:

Properties:
Name Type Summary
name string Pre-defined component
Component value.

Content
Summary: Description
Description:

369 | P a g e
 Bitbucket

Properties:
Name Type Summary
raw string The description of the
text issue.
markup string The description markup of
markup the issue.
html string The description html of
html the issue.

Version
Summary:
Description:

Properties:
Name Type Summary
name string A version value defined by
Version the administrator.

Milestone
Summary:
Description:

Properties:
Name Type Summary
name string Pre-defined milestone
Milestone value.

370 | P a g e
 Bitbucket

ListComponentMilestoneVersionResponse
Summary:
Description:

Properties:
Name Type Summary
values array of (ValuesItem) values
values

ValuesItem
Summary:
Description:

Properties:
Name Type Summary
name string name
name

371 | P a g e
 Bitbucket

List_pull_requests_Response
Summary:
Description:

Properties:
Name Type Summary
values array of (ValuesItem) values
PR

ValuesItem
Summary:
Description:

Properties:
Name Type Summary
title string Title of the pull request.
Title
id integer(int32) Id of the pull request.
Id

372 | P a g e
 Bitbucket

List_repositories_Response
Summary:
Description:

Properties:
Name Type Summary
values array of (ValuesItem) values
values

ValuesItem
Summary:
Description:

Properties:
Name Type Summary
scm string Source control manager for
SCM the repository.
website string Url of the website if defined.
Website
has_wiki boolean True if the repository has a
Has Wiki wiki.
name string Repository's name.
Name
fork_policy string Allow forks, no public forks
Fork Policy or no forks.
uuid string Repository's immutable id.
UUID
language string Programming language used
Language in the repository.

373 | P a g e
 Bitbucket

created_on string(date-time) yyyy-MM-

Created Date-Time ddTHH:mm:ss.fff(+hh:mm or
-hh:mm)
has_issues boolean True if an issue tracker has
Has Issue Tracker been set for the repository.
owner Owner owner
Owner
updated_on string(date-time) yyyy-MM-
Updated Date-Time ddTHH:mm:ss.fff(+hh:mm or
-hh:mm)
size integer(int32) Integer indicating size of the
Size repository in bytes.
type string Git or mercurial.
Type
slug string Slug used to identify the
Slug repository.
is_private boolean True if the repository is
Is private private.
description string The repository's description.
Description

Owner
Summary: Owner
Description: owner

Properties:
Name Type Summary
username string Username of the
Username repository's owner.

374 | P a g e
 Bitbucket

display_name string Display name of the

Name repository's owner.
uuid string Unique identifier of the
UUID repository's owner.

375 | P a g e
 Bitbucket

UserResponse
Summary:
Description:

Properties:
Name Type Summary
username string The username.
Username
type string The user type.
Type
display_name string The display name of the
Display Name user.
uuid string The universally unique
UUID identifier of the user.

376 | P a g e
 Bitbucket

WebhookRequest
Summary:
Description:

Properties:
Name Type Summary
description string A description of the
Description webhook being created.
url string url
url
active boolean active
active
events array of (string) events
events

377 | P a g e
 Bitly

Bitly
Bitly is a link management tool. You can shorten links, reroute existing ones
and associate them with campaigns across channels and devices.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
CreateBitlink (string longUrl) Create a bitlink

Triggers:
Name Summary
OnBitlinkCreated () When a Bitlink is created

Objects:
Name Summary
Bitlink Bitlink
OnBitlinkCreatedResponseItem Bitlink

Actions:
CreateBitlink
Summary: Create a bitlink
Description: Create a shortened Bitlink

Syntax:
Bitly.CreateBitlink (string longUrl)

378 | P a g e
 Bitly

Parameters:
Name Type Summary Required Related
Action
longUrl string The URL to True
(URL) shorten

Returns:
Type:Bitlink
Summary: Bitlink
Description: A Bitlink including both shortened and original URL

Triggers:
Trigger OnBitlinkCreated
Summary: When a Bitlink is created
Description: When a Bitlink is created

Syntax:
Bitly.OnBitlinkCreated ()

Returns:
Type:array of (OnBitlinkCreatedResponseItem)

379 | P a g e
 Bitly

Bitlink
Summary: Bitlink
Description: A Bitlink including both shortened and original URL

Properties:
Name Type Summary
url string The shortened Url
Url
long_url string The original long Url
Long Url

380 | P a g e
 Bitly

OnBitlinkCreatedResponseItem
Summary: Bitlink
Description: A Bitlink including both shortened and original URL

Properties:
Name Type Summary
url string The shortened Url
Url
long_url string The original long Url
Long Url

381 | P a g e
 Blogger

Blogger
Blogger is a blog publishing service. It allows you to create websites and post
to them on an ongoing basis.

Status: Preview Tier: Standard Version: 1.1

Actions:
Name Summary
ListBlogs () List user blogs
ListPosts (string blogId, List all posts
[advanced][Optional]string
status)
CreatePost (string blogId, Create post
CreatePostRequest post,
[Optional]boolean isDraft)
GetPost (string blogId, string Get a post
postId)
EditPost (string blogId, string Edit a post
postId, UpdatePostRequest
post)
DeletePost (string blogId, Delete a post
string postId)
PublishPost (string blogId, Publish a post
string postId)
RevertPost (string blogId, Revert a post
string postId)

382 | P a g e
 Blogger

Triggers:
Name Summary
OnPostCreated (string blogId, When a post is created
string status)

Objects:
Name Summary
Blog
BlogList
CreatePostRequest
Location
Object
Post
PostList
UpdatePostRequest

Actions:
ListBlogs
Summary: List user blogs
Description: Lists all blogs for the current user

Syntax:
Blogger.ListBlogs ()

Returns:
Type:BlogList
Description: A list of Blogger blogs

383 | P a g e
 Blogger

ListPosts
Summary: List all posts
Description: List all posts

Syntax:
Blogger.ListPosts (string blogId, [advanced][Optional]string
status)

Parameters:
Name Type Summary Required Related
Action
blogId string Blog True ListBlogs
(Blog Id)
status string Status of the False
(Status) posts to retrieve
(live or draft)

Returns:
Type:PostList
Description: A list of Blogger posts

CreatePost
Summary: Create post
Description: Create post

Syntax:
Blogger.CreatePost (string blogId, CreatePostRequest post,
[Optional]boolean isDraft)

384 | P a g e
 Blogger

Parameters:
Name Type Summary Required Related
Action
blogId string Blog True ListBlogs
(Blog Id)
post CreatePostRequest A Blogger post True
object for new
post requests
isDraft boolean Indicate if this False
(Draft) post should be
saved as a
draft

Returns:
Type:Post
Description: A Blogger post object

GetPost
Summary: Get a post
Description: Get a post

Syntax:
Blogger.GetPost (string blogId, string postId)

Parameters:
Name Type Summary Required Related
Action
blogId string Blog True ListBlogs
(Blog Id)

385 | P a g e
 Blogger

postId string Post True ListPosts

(Post Id)

Returns:
Type:Post
Description: A Blogger post object

EditPost
Summary: Edit a post
Description: Edit a post

Syntax:
Blogger.EditPost (string blogId, string postId,
UpdatePostRequest post)

Parameters:
Name Type Summary Required Related
Action
blogId string Blog True ListBlogs
(Blog Id)
postId string Post True ListPosts
(Post Id)
post UpdatePostRequest A Blogger post True
object for new
post requests

Returns:
Type:Post
Description: A Blogger post object

386 | P a g e
 Blogger

DeletePost
Summary: Delete a post
Description: Delete a post

Syntax:
Blogger.DeletePost (string blogId, string postId)

Parameters:
Name Type Summary Required Related
Action
blogId string Blog True ListBlogs
(Blog Id)
postId string Post True ListPosts
(Post Id)

Returns:
Type:Object

PublishPost
Summary: Publish a post
Description: Publish a post

Syntax:
Blogger.PublishPost (string blogId, string postId)

Parameters:

387 | P a g e
 Blogger

Name Type Summary Required Related

Action
blogId string Blog True ListBlogs
(Blog Id)
postId string Post True ListPosts
(Post Id)

Returns:
Type:Post
Description: A Blogger post object

RevertPost
Summary: Revert a post
Description: Revert a post

Syntax:
Blogger.RevertPost (string blogId, string postId)

Parameters:
Name Type Summary Required Related
Action
blogId string Blog True ListBlogs
(Blog Id)
postId string Post True ListPosts
(Post Id)

Returns:
Type:Post
Description: A Blogger post object

388 | P a g e
 Blogger

Triggers:
Trigger OnPostCreated
Summary: When a post is created
Description: Triggers a flow when a new post is created

Syntax:
Blogger.OnPostCreated (string blogId, string status)

Parameters:
Name Type Summary Required Related
Action
blogId string Select a blog to True ListBlogs
(Blog Id) watch
status string Status of the True
(Post posts to retrieve
Status)Values:
[Draft, Live,
All]

Returns:
Type:array of (Post)

389 | P a g e
 Blogger

Blog
Summary:
Description: A Blogger blog object

Properties:
Name Type Summary
id string The id of the blog
Blog ID
name string The name of the blog
Blog name
description string The description of the
Blog description blog
published string(date-time) The published date of the
Published date blog
updated string(date-time) The updated date of the
Updated date blog
url string The url of the blog
Blog URL
status string The status of the blog
Status

390 | P a g e
 Blogger

BlogList
Summary:
Description: A list of Blogger blogs

Properties:
Name Type Summary
items array of (Blog) The list of blog items
Blogs

391 | P a g e
 Blogger

CreatePostRequest
Summary:
Description: A Blogger post object for new post requests

Properties:
Name Type Summary
title string The title of the post
Title
content string The content of the post
Content
labels array of (string) The labels for the post
Labels

392 | P a g e
 Blogger

Location
Summary:
Description: A Location blog object

Properties:
Name Type Summary
name string The name of the location
Location Name
lat number(double) The latitude of the
Latitude location
lng number(double) The longitude of the
Longitude location
span string The viewport span. Can be
Location Span used when rendering a
map preview

393 | P a g e
 Blogger

Object
Summary:
Description:

Properties:
Name Type Summary

394 | P a g e
 Blogger

Post
Summary:
Description: A Blogger post object

Properties:
Name Type Summary
id string The id of the post
Post Id
blog.id string The associated blog id of
Blog Id the post
published string(date-time) The published date of the
Published Date post
updated string(date-time) The updated date of the
Updated Date post
url string The url where this post is
Post URL displayed
title string The title of the post
Title
content string The content of the post
Post content
author.id string The id of the author
Author Id
author.displayName string The name of the author
Author Name
author.url string The url of the author
Author URL
author.image.url string The URL of the image of
Author Image URL the author

395 | P a g e
 Blogger

labels array of (string) The list of this post's

Labels labels
location Location A Location blog object

status string The status of the post

Status

396 | P a g e
 Blogger

PostList
Summary:
Description: A list of Blogger posts

Properties:
Name Type Summary
items array of (Post) The list of blog post items
Posts

397 | P a g e
 Blogger

UpdatePostRequest
Summary:
Description: A Blogger post object for new post requests

Properties:
Name Type Summary
title string The title of the post
Title
content string The content of the post
Content
labels array of (string) The labels for the post
Labels

398 | P a g e
 bttn

bttn
bttn - The simplest internet user interface in the world.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
ListBttns ([internal]string Get list of bttns
fields, [internal]string filter)
DeleteWebhook (string Delete Webhook
hookId)
ReturnFlowResult (string Return Flow result
callbackId, CallbackBody
Callback Body)
GetBttnInfo (string id) Get bttn info
GetBttnCounter (string id) Get bttn counter value

Triggers:
Name Summary
RegisterWebhook (string id, When a bttn is pressed
WebhookRequestBody
Webhook Request Body)

Objects:
Name Summary
BttnApiCounter
BttnApiInfo

399 | P a g e
 bttn

BttnListData
CallbackBody
WebhookRequestBody

Actions:
ListBttns
Summary: Get list of bttns
Description: Gets list of bttns associated with the account.

Syntax:
bttn.ListBttns ([internal]string fields, [internal]string
filter)

Parameters:
Name Type Summary Required Related
Action
fields string comma True
(fields to separated list of
include in field keys:
response bid|name_id...
items)
filter string all - all bttns, True
(Filter)Values: active - only
[all, active] bttns associated
with microsoft
flow on the bttn
portal

Returns:

400 | P a g e
 bttn

Type:array of (BttnListData)
Summary: Bttn device list

DeleteWebhook
Summary: Delete Webhook
Description: Delete a previously assigned bt.tn webhook

Syntax:
bttn.DeleteWebhook (string hookId)

Parameters:
Name Type Summary Required Related
Action
hookId string Id as returned True
(Id of from bt.tn API
webhook to upon webhook
delete) creation

Returns:

ReturnFlowResult
Summary: Return Flow result
Description: Reflect Flow result via bttn device lights.

Syntax:
bttn.ReturnFlowResult (string callbackId, CallbackBody Callback
Body)

Parameters:

401 | P a g e
 bttn

Name Type Summary Required Related

Action
callbackId string CallbackId as True
(Callback Id) received in the
bttn trigger.
Callback Body CallbackBody True

Returns:

GetBttnInfo
Summary: Get bttn info
Description: Gets the bttn device identification information.

Syntax:
bttn.GetBttnInfo (string id)

Parameters:
Name Type Summary Required Related
Action
id string Bttn short ID or True ListBttns
(Bttn ID) device ID.

Returns:
Type:BttnApiInfo

GetBttnCounter
Summary: Get bttn counter value
Description: Gets the bttn counter value.

402 | P a g e
 bttn

Syntax:
bttn.GetBttnCounter (string id)

Parameters:
Name Type Summary Required Related
Action
id string Bttn short ID or True ListBttns
(Bttn ID) device ID.

Returns:
Type:BttnApiCounter

Triggers:
Trigger RegisterWebhook
Summary: When a bttn is pressed
Description: Trigger a flow with a press of a bttn.

Syntax:
bttn.RegisterWebhook (string id, WebhookRequestBody Webhook
Request Body)

Parameters:
Name Type Summary Required Related
Action
id string bttn short ID True ListBttns
(bttn ID) or device ID.

403 | P a g e
 bttn

Webhook Request WebhookRequestBody True

Body

Returns:

404 | P a g e
 bttn

BttnApiCounter
Summary:
Description:

Properties:
Name Type Summary
counter integer Total count of bttn presses
Counter (short/long/not pressed)
bid integer Short ID of the bttn (bid)
Short ID
address string Device ID of the bttn
Device ID
name string The name of the bttn as
Name set on the my.bt.tn portal
emailaddress string E-mail address associated
Email address with the bttn on the
my.bt.tn portal
location string Location of the button as
Location set on the my.bt.tn portal
url string Reference URL of the bt.tn
Reference URL
language string Language as set for the
Language bttn on the my.bt.tn portal
timezone string bttn timezone as specified
Timezone on the my.bt.tn portal
user string User name associated with
User name the button on the my.bt.tn
portal

405 | P a g e
 bttn

BttnApiInfo
Summary:
Description:

Properties:
Name Type Summary
bid integer Short ID of the bttn (bid)
Short ID
address string Device ID of the bttn
Device ID
name string The name of the bttn as
Name set on the my.bt.tn portal
emailaddress string E-mail address associated
Email address with the bttn on the
my.bt.tn portal
location string Location of the button as
Location set on the my.bt.tn portal
url string Reference URL of the bt.tn
Reference URL
language string Language as set for the
Language bttn on the my.bt.tn
portal
timezone string bttn timezone as specified
Timezone on the my.bt.tn portal
user string User name associated
User name with the button on the
my.bt.tn portal

406 | P a g e
 bttn

BttnListData
Summary:
Description:

Properties:
Name Type Summary
bid integer Short ID of the bttn (bid)
Short ID
name_id string The name of the bttn as
Name set on the my.bt.tn portal

407 | P a g e
 bttn

CallbackBody
Summary:
Description:

Properties:
Name Type Summary
result string Positive for success,
Flow Result Negative for failure, Wait
to extend timeout period
Values: [Positive, Negative,
Wait]

408 | P a g e
 bttn

WebhookRequestBody
Summary:
Description:

Properties:
Name Type Summary
url string Url to call in order to
Webhook url trigger webhook

409 | P a g e
 Buffer

Buffer
Buffer is a social media management for marketers and agencies. Access your
pending and sent updates, social media profiles, and more.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
CreateUpdate (string Create an update
CreateUpdateProfileId, string
CreateUpdateText)
ShareUpdate (string Share an update
profile_id, string udpate_id)
ListProfiles () List profiles
ListUpdates (string profile_id) List updates

Triggers:
Name Summary
TrigPendingUpdates (string When an update is pending
profile_id)
TrigSentUpdates (string When an update is shared
profile_id)

Objects:
Name Summary
CreateUpdateResponse
ListPendingUpdatesResponse

410 | P a g e
 Buffer

ListProfilesResponseItem
ListSentUpdatesResponse
ShareUpdateResponse

Actions:
CreateUpdate
Summary: Create an update
Description: Create an update for a specific profile.

Syntax:
Buffer.CreateUpdate (string CreateUpdateProfileId, string
CreateUpdateText)

Parameters:
Name Type Summary Required Related
Action
CreateUpdateProfileId string Profile True ListProfiles
(Profile ID)
CreateUpdateText string True
(Text)

Returns:
Type:CreateUpdateResponse

ShareUpdate
Summary: Share an update
Description: Share a pending update.

Syntax:

411 | P a g e
 Buffer

Buffer.ShareUpdate (string profile_id, string udpate_id)

Parameters:
Name Type Summary Required Related
Action
profile_id string Profile True ListProfiles
(Profile ID)
udpate_id string Update True ListUpdates
(Update ID)

Returns:
Type:ShareUpdateResponse

ListProfiles
Summary: List profiles
Description: List profiles

Syntax:
Buffer.ListProfiles ()

Returns:
Type:array of (ListProfilesResponseItem)

ListUpdates
Summary: List updates
Description: List pending updates for the specified social media profile.

Syntax:
Buffer.ListUpdates (string profile_id)

412 | P a g e
 Buffer

Parameters:
Name Type Summary Required Related
Action
profile_id string Profile True ListProfiles
(Profile ID)

Returns:
Type:ListPendingUpdatesResponse

Triggers:
Trigger TrigPendingUpdates
Summary: When an update is pending
Description: Triggers a new flow When an update is pending.

Syntax:
Buffer.TrigPendingUpdates (string profile_id)

Parameters:
Name Type Summary Required Related
Action
profile_id string Profile True ListProfiles
(Profile ID)

Returns:
Type:ListPendingUpdatesResponse

Trigger TrigSentUpdates
Summary: When an update is shared

413 | P a g e
 Buffer

Description: Triggers a new flow When an update is shared.

Syntax:
Buffer.TrigSentUpdates (string profile_id)

Parameters:
Name Type Summary Required Related
Action
profile_id string Profile True ListProfiles
(Profile ID)

Returns:
Type:ListSentUpdatesResponse

414 | P a g e
 Buffer

CreateUpdateResponse
Summary:
Description:

Properties:
Name Type Summary
updates array of (UpdatesItem) updates

UpdatesItem
Summary:
Description:

Properties:
Name Type Summary
created_at integer(int32) The datetime the update
Created At was created at.
day string The text version of the
Day date the update is due.
due_at integer(int32) The datetime when the
Due At update is due.
due_time string The time when the
Due Time update is due.
id string The id of the update.
Id
profile_id string The id of the profile
Profile Id associated with the
update.

415 | P a g e
 Buffer

profile_service string The service of the profile

Profile Update associated with the
update.
shared_now boolean A boolean value
IsSharedNow indicating if the update is
shared.
status string The status of the update.
Status
text string The text of the update.
Text
text_formatted string The formatted text of the
Text Formatted update.
type string The type of update.
Type
updated_at integer(int32) The datetime the update
Updated At was updated.
user_id string The id of the user.
User Id
via string How the update was
Via created.

416 | P a g e
 Buffer

ListPendingUpdatesResponse
Summary:
Description:

Properties:
Name Type Summary
updates array of (UpdatesItem) updates

UpdatesItem
Summary:
Description:

Properties:
Name Type Summary
created_at integer(int32) The datetime the update
Created At was created at.
day string The text version of the
Day date the update is due.
due_at integer(int32) The datetime when the
Due At update is due.
due_time string The time when the
Due Time update is due.
id string The id of the update.
Id
profile_id string The id of the profile
Profile Id associated with the
update.

417 | P a g e
 Buffer

profile_service string The service of the profile

Profile Update associated with the
update.
shared_now boolean A boolean value
IsSharedNow indicating if the update is
shared.
status string The status of the update.
Status
text string The text of the update.
Text
text_formatted string The formatted text of the
Text Formatted update.
type string The type of update.
Type
updated_at integer(int32) The datetime the update
Updated At was updated.
user_id string The id of the user.
User Id
via string How the update was
Via created.

418 | P a g e
 Buffer

ListProfilesResponseItem
Summary:
Description:

Properties:
Name Type Summary
avatar string The URL to the avatar of
Avatar the profile.
counts Counts

default boolean A boolean value

IsDefault indicating if the profile is
the default profile.
disabled boolean A boolean value
IsDisabled indicating if the profile is
disabled.
disconnected boolean A boolean value
IsDisconnected indicating if the profile is
disconnected.
id string The id of the profile
Id
locked boolean A boolean value
IsLocked indicating if the profile is
locked.
service string The service connected to
service the profile.
service_id string The id of the service
Service Id connected to the profile.

419 | P a g e
 Buffer

service_type string The type of service

Service Type connected to the profile.
service_username string The username for the
service_username service connected to the
profile.
timezone string The selected timezone for
Timezone the profile.
timezone_city string The city name
Timezone City corresponding to the
selected timezone.
user_id string The id of the user who
User Id created the profile.
dropdown_label string A label consisting of the
Label service connected to the
profile, as well as the
profile username.

Counts
Summary:
Description:

Properties:
Name Type Summary
drafts integer(int32) The number of draft
Drafts updates.
reminders integer(int32) The number of reminders.
Reminders
sent integer(int32) The number of sent
sent updates.

420 | P a g e
 Buffer

pending integer(int32) The number of pending

Pending updates.

421 | P a g e
 Buffer

ListSentUpdatesResponse
Summary:
Description:

Properties:
Name Type Summary
updates array of (UpdatesItem) updates

UpdatesItem
Summary:
Description:

Properties:
Name Type Summary
created_at integer(int32) The datetime the update
Created At was created at.
day string The text version of the
Day date the update is due.
due_at integer(int32) The datetime when the
Due At update is due.
due_time string The time when the
Due Time update is due.
id string The id of the update.
Id
profile_id string The id of the profile
Profile Id associated with the
update.

422 | P a g e
 Buffer

profile_service string The service of the profile

Profile Update associated with the
update.
shared_now boolean A boolean value
IsSharedNow indicating if the update is
shared.
status string The status of the update.
Status
text string The text of the update.
Text
text_formatted string The formatted text of the
Text Formatted update.
type string The type of update.
Type
updated_at integer(int32) The datetime the update
Updated At was updated.
user_id string The id of the user.
User Id
via string How the update was
Via created.
statistics Statistics

Statistics
Summary:
Description:

Properties:
Name Type Summary

423 | P a g e
 Buffer

comments integer(int32) The number of comments

Comments on the update.
likes integer(int32) The number of likes on
Likes the update.
clicks integer(int32) The number of clicks on
Clicks the update.

424 | P a g e
 Buffer

ShareUpdateResponse
Summary:
Description:

Properties:
Name Type Summary
success boolean A boolean value indicating
IsSuccess if the update was
successfully shared.

425 | P a g e
 Campfire

Campfire
Campfire is an instant messaging tool used for communication and file sharing
within teams.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
ListAccounts ([Optional]string List accounts
parentOperation)
ListRooms (string account) List Rooms
ListMessages (string account, List Messages
string roomId)
ListUploads (string account, List Uploads
string roomId)
CreateMessage (string Create a message
account, string roomId, string
message)
GetUser (string account, Get user by ID
integer userId)

Triggers:
Name Summary
OnNewRoom (string account) When a room is created
OnNewMessage (string When a new message is received
account, string roomId)
OnNewUpload (string When a file is uploaded
account, string roomId)

426 | P a g e
 Campfire

Objects:
Name Summary
AccountsResponse
CreateMessageResponse
MessagesResponse
RoomsResponse
UploadResponse
UserResponse

Actions:
ListAccounts
Summary: List accounts
Description: Retrieves the list of accounts this user has access too

Syntax:
Campfire.ListAccounts ([Optional]string parentOperation)

Parameters:
Name Type Summary Required Related
Action
parentOperation string False

Returns:
Type:AccountsResponse
Description: Account data for an account in Campfire

427 | P a g e
 Campfire

ListRooms
Summary: List Rooms
Description: Retrieves the list of rooms in an account

Syntax:
Campfire.ListRooms (string account)

Parameters:
Name Type Summary Required Related
Action
account string Account in True ListAccounts
(Account) Campfire

Returns:
Type:RoomsResponse
Description: Collection of Room Data

ListMessages
Summary: List Messages
Description: Retrieves messages in a room

Syntax:
Campfire.ListMessages (string account, string roomId)

Parameters:
Name Type Summary Required Related
Action

428 | P a g e
 Campfire

account string Account in True ListAccounts

(Account) Campfire
roomId string A room True ListRooms
(RoomId) associated with
the account

Returns:
Type:MessagesResponse
Description: A collection of message data in Campfire

ListUploads
Summary: List Uploads
Description: Retrieves the uploads in a room

Syntax:
Campfire.ListUploads (string account, string roomId)

Parameters:
Name Type Summary Required Related
Action
account string Account in True ListAccounts
(Account) Campfire
roomId string A room True ListRooms
(RoomId) associated with
the account

Returns:
Type:UploadResponse
Description: Data for uploaded files in Campfire

429 | P a g e
 Campfire

CreateMessage
Summary: Create a message
Description: Sends a message to the given room.

Syntax:
Campfire.CreateMessage (string account, string roomId, string
message)

Parameters:
Name Type Summary Required Related
Action
account string Account in True ListAccounts
(Account) Campfire
roomId string A room True ListRooms
(RoomId) associated with
the account
message string Message text to True
(Message be created
text to be
created)

Returns:
Type:CreateMessageResponse
Description: A message

GetUser
Summary: Get user by ID
Description: Retrieves information about a user by given ID

430 | P a g e
 Campfire

Syntax:
Campfire.GetUser (string account, integer userId)

Parameters:
Name Type Summary Required Related
Action
account string Account in True ListAccounts
(Account) Campfire
userId integer(int32) User ID True
(User ID)

Returns:
Type:UserResponse

Triggers:
Trigger OnNewRoom
Summary: When a room is created
Description: Triggers when a new room is added to the authenticated user's account.
Not applicable to Basecamp.

Syntax:
Campfire.OnNewRoom (string account)

Parameters:
Name Type Summary Required Related
Action

431 | P a g e
 Campfire

account string Account in True ListAccounts

(Account) Campfire

Returns:
Type:RoomsResponse
Description: Collection of Room Data

Trigger OnNewMessage
Summary: When a new message is received
Description: Triggers when a new message is received in a given room.

Syntax:
Campfire.OnNewMessage (string account, string roomId)

Parameters:
Name Type Summary Required Related
Action
account string Account in True ListAccounts
(Account) Campfire
roomId string A room True ListRooms
(RoomId) associated with
the account

Returns:
Type:MessagesResponse
Description: A collection of message data in Campfire

Trigger OnNewUpload
Summary: When a file is uploaded

432 | P a g e
 Campfire

Description: Triggers when a file is uploaded to a given room. Not applicable to

Basecamp.

Syntax:
Campfire.OnNewUpload (string account, string roomId)

Parameters:
Name Type Summary Required Related
Action
account string Account in True ListAccounts
(Account) Campfire
roomId string A room True ListRooms
(RoomId) associated with
the account

Returns:
Type:UploadResponse
Description: Data for uploaded files in Campfire

433 | P a g e
 Campfire

AccountsResponse
Summary:
Description: Account data for an account in Campfire

Properties:
Name Type Summary
accounts array of (AccountsItem) Collection Of Accounts
Accounts

AccountsItem
Summary:
Description: Account in Campfire

Properties:
Name Type Summary
id integer(int32) Id of the account
Account Id
name string Name of the account
Account Name
app_href string Link to the account
Account Link
account_url string Account Url
Account url

434 | P a g e
 Campfire

CreateMessageResponse
Summary:
Description: A message

Properties:
Name Type Summary
message Message A Campfire message

Message
Summary:
Description: A Campfire message

Properties:
Name Type Summary
body string Message Body.
Message Body
id integer(int32) Message Id.
Message Id
starred boolean Boolean value, true if a
Message Starred message is starred.
user_id integer(int32) The unique ID of the user
User ID who created the message.

435 | P a g e
 Campfire

MessagesResponse
Summary:
Description: A collection of message data in Campfire

Properties:
Name Type Summary
messages array of (MessagesItem) Collection Of messages
Messages

MessagesItem
Summary:
Description: A Campfire message

Properties:
Name Type Summary
body string Message Body.
Message Body
id integer(int32) Message Id.
Message Id
starred boolean Boolean value, True if a
Message Starred message is starred.
user_id integer(int32) The unique ID of the user
User ID who created the message.

436 | P a g e
 Campfire

RoomsResponse
Summary:
Description: Collection of Room Data

Properties:
Name Type Summary
rooms array of (RoomsItem) Collection of Rooms
Rooms

RoomsItem
Summary:
Description: Data associated with a room

Properties:
Name Type Summary
name string Room name.
Room Name
id string Room Id.
Room Id
locked boolean Boolean value, True if a
Room Locked room is locked.
topic string Room topic or description.
Room Topic

437 | P a g e
 Campfire

UploadResponse
Summary:
Description: Data for uploaded files in Campfire

Properties:
Name Type Summary
uploads array of (UploadsItem) Collection of Uploads
Uploads

UploadsItem
Summary:
Description: Data for an uploaded file in Campfire

Properties:
Name Type Summary
full_url string File Url.
File Url
room_id integer(int32) Room Id.
Room Id
id integer(int32) File Id.
File Id
content_type string Format of the uploaded
Content Type file.
name string File name.
File Name
created_at string(date-time) Timestamp of upload.
Created At

438 | P a g e
 Campfire

UserResponse
Summary:
Description:

Properties:
Name Type Summary
user User

User
Summary:
Description:

Properties:
Name Type Summary
email_address string
User Email
name string
User Name
id integer(int32)
User ID

439 | P a g e
 Capsule CRM

Capsule CRM
Online CRM for individuals, small businesses and sales teams wanting a
simple, effective and affordable solution.

Status: Preview Tier: Premium Version: 1.0.0

Actions:
Name Summary
ListOpportunities () List opportunities
CreateOpportunity Create opportunity
(Createopportunity_Request
body)
GetOpportunity (string Get opportunity
opportunityId)
UpdateOpportunity (string Update opportunity
opportunityId,
Updateopportunity_Request
body)
DeleteOpportunity (string DeleteOpportunity
opportunityId)
CreatePerson Create person
(Createperson_Request body)
UpdatePerson (string Update person
personId,
Updateperson_Request body)
CreateOrganisation Create organisation
(Createorganisation_Request
body)

440 | P a g e
 Capsule CRM

UpdateOrganisation (string id, Update organisation

Updateorganisation_Request
body)
ListParties () List parties
ListPeople () List people
ListOrganizations () List organizations
GetParty (string personId) Get party
DeleteParty (string personId) Delete party
ListTasks () List tasks
CreateTask Create task
(Createtask_Request body)
CompleteTask (string taskId, Complete task
Completetask_Request body)
ListMilestones () List milestones
ListCurrencies () List currencies

Triggers:
Name Summary
OnNewOpportunity () When an opportunity is created
OnUpdateOpportunity () When an opportunity is updated
OnNewTask () When a task is created
OnNewParty () When a party is created

Objects:
Name Summary
CompleteTaskResponse
Completetask_Request
CreateOpportunityResponse

441 | P a g e
 Capsule CRM

Createopportunity_Request
CreateOrganisationResponse
Createorganisation_Request
CreatePersonResponse
Createperson_Request
CreateTaskResponse
Createtask_Request
GetOpportunityResponse
GetPartyResponse
Listcurrencies_Response
Listmilestones_Response
ListOpportunitiesResponse
Listparties_Response
ListTasksResponse
Opportunity_Response
Party_Response
Task_Response
UpdateOpportunityResponse
Updateopportunity_Request
UpdateOrganisationResponse
Updateorganisation_Request
UpdatePersonResponse
Updateperson_Request

Actions:
ListOpportunities
Summary: List opportunities
Description: This operation retrieves a list of all opportunities in your Capsule account.

442 | P a g e
 Capsule CRM

Syntax:
CapsuleCRM.ListOpportunities ()

Returns:
Type:ListOpportunitiesResponse

CreateOpportunity
Summary: Create opportunity
Description: This operation is used to create a new opportunity in your account.

Syntax:
CapsuleCRM.CreateOpportunity (Createopportunity_Request body)

Parameters:
Name Type Summary Required Related
Action
body Createopportunity_Request True

Returns:
Type:CreateOpportunityResponse

GetOpportunity
Summary: Get opportunity
Description: This operation is used to retrieve all information about an opportunity.

Syntax:
CapsuleCRM.GetOpportunity (string opportunityId)

443 | P a g e
 Capsule CRM

Parameters:
Name Type Summary Required Related
Action
opportunityId string True
(Opportunity
Id)

Returns:
Type:GetOpportunityResponse

UpdateOpportunity
Summary: Update opportunity
Description: This operation is used to update information about an existing
opportunity.

Syntax:
CapsuleCRM.UpdateOpportunity (string opportunityId,
Updateopportunity_Request body)

Parameters:
Name Type Summary Required Related
Action
opportunityId string True
(Opportunity Id)
body Updateopportunity_Request True

Returns:
Type:UpdateOpportunityResponse

444 | P a g e
 Capsule CRM

DeleteOpportunity
Summary: DeleteOpportunity
Description: This operation is used to delete an existing opportunity.

Syntax:
CapsuleCRM.DeleteOpportunity (string opportunityId)

Parameters:
Name Type Summary Required Related
Action
opportunityId string True
(Opportunity
Id)

Returns:
Type:string

CreatePerson
Summary: Create person
Description: This operation is used to create a new person in your Capsule account.

Syntax:
CapsuleCRM.CreatePerson (Createperson_Request body)

Parameters:
Name Type Summary Required Related
Action

445 | P a g e
 Capsule CRM

body Createperson_Request True

Returns:
Type:CreatePersonResponse

UpdatePerson
Summary: Update person
Description: This operation is used to update the information about an existing person
in your Capsule account.

Syntax:
CapsuleCRM.UpdatePerson (string personId, Updateperson_Request
body)

Parameters:
Name Type Summary Required Related
Action
personId string True
(Party Id)
body Updateperson_Request True

Returns:
Type:UpdatePersonResponse

CreateOrganisation
Summary: Create organisation

446 | P a g e
 Capsule CRM

Description: This operation is used to create a new organisation in your Capsule

account.

Syntax:
CapsuleCRM.CreateOrganisation (Createorganisation_Request body)

Parameters:
Name Type Summary Required Related
Action
body Createorganisation_Request True

Returns:
Type:CreateOrganisationResponse

UpdateOrganisation
Summary: Update organisation
Description: This operation is used to update information about an existing
organisation.

Syntax:
CapsuleCRM.UpdateOrganisation (string id,
Updateorganisation_Request body)

Parameters:
Name Type Summary Required Related
Action
id string True
(Party Id)

447 | P a g e
 Capsule CRM

body Updateorganisation_Request True

Returns:
Type:UpdateOrganisationResponse

ListParties
Summary: List parties
Description: This operation is used to retrieve a list of all parties in your Capsule
account.

Syntax:
CapsuleCRM.ListParties ()

Returns:
Type:Listparties_Response

ListPeople
Summary: List people
Description: This operation is used to retrieve a list of all people in your Capsule
account.

Syntax:
CapsuleCRM.ListPeople ()

Returns:
Type:Listparties_Response

448 | P a g e
 Capsule CRM

ListOrganizations
Summary: List organizations
Description: This operation is used to retrieve a list of all organisations in your
account.

Syntax:
CapsuleCRM.ListOrganizations ()

Returns:
Type:Listparties_Response

GetParty
Summary: Get party
Description: This operation retrieves all information about an existing party.

Syntax:
CapsuleCRM.GetParty (string personId)

Parameters:
Name Type Summary Required Related
Action
personId string True
(Party Id)

Returns:
Type:GetPartyResponse

DeleteParty
Summary: Delete party

449 | P a g e
 Capsule CRM

Description: This operation is used to delete a party from your account.

Syntax:
CapsuleCRM.DeleteParty (string personId)

Parameters:
Name Type Summary Required Related
Action
personId string True
(Party Id)

Returns:
Type:string

ListTasks
Summary: List tasks
Description: This operation is used to retrieve a list of tasks.

Syntax:
CapsuleCRM.ListTasks ()

Returns:
Type:ListTasksResponse

CreateTask
Summary: Create task
Description: This operation is used to create a new task.

Syntax:

450 | P a g e
 Capsule CRM

CapsuleCRM.CreateTask (Createtask_Request body)

Parameters:
Name Type Summary Required Related
Action
body Createtask_Request True

Returns:
Type:CreateTaskResponse

CompleteTask
Summary: Complete task
Description: This operation is used to complete a task.

Syntax:
CapsuleCRM.CompleteTask (string taskId, Completetask_Request
body)

Parameters:
Name Type Summary Required Related
Action
taskId string True
(Task Id)
body Completetask_Request True

Returns:
Type:CompleteTaskResponse

451 | P a g e
 Capsule CRM

ListMilestones
Summary: List milestones
Description: This operation returns a list of milestones.

Syntax:
CapsuleCRM.ListMilestones ()

Returns:
Type:Listmilestones_Response

ListCurrencies
Summary: List currencies
Description: This operation returns a list of currencies.

Syntax:
CapsuleCRM.ListCurrencies ()

Returns:
Type:Listcurrencies_Response

Triggers:
Trigger OnNewOpportunity
Summary: When an opportunity is created
Description: This operation triggers when a new opportunity is created in your
account.

Syntax:

452 | P a g e
 Capsule CRM

CapsuleCRM.OnNewOpportunity ()

Returns:
Type:array of (Opportunity_Response)

Trigger OnUpdateOpportunity
Summary: When an opportunity is updated
Description: This operation triggers when an existing opportunity is updated in your
account.

Syntax:
CapsuleCRM.OnUpdateOpportunity ()

Returns:
Type:array of (Opportunity_Response)

Trigger OnNewTask
Summary: When a task is created
Description: This operation triggers when a task is created in your account.

Syntax:
CapsuleCRM.OnNewTask ()

Returns:
Type:array of (Task_Response)

Trigger OnNewParty
Summary: When a party is created
Description: This operation triggers when a new party is created in your account.
453 | P a g e
 Capsule CRM

Syntax:
CapsuleCRM.OnNewParty ()

Returns:
Type:array of (Party_Response)

454 | P a g e
 Capsule CRM

CompleteTaskResponse
Summary:
Description:

Properties:
Name Type Summary
task Task_Response

455 | P a g e
 Capsule CRM

Completetask_Request
Summary:
Description:

Properties:
Name Type Summary
task Task

Task
Summary:
Description:

Properties:
Name Type Summary
status string
Status

456 | P a g e
 Capsule CRM

CreateOpportunityResponse
Summary:
Description:

Properties:
Name Type Summary
opportunity Opportunity_Response

457 | P a g e
 Capsule CRM

Createopportunity_Request
Summary:
Description:

Properties:
Name Type Summary
opportunity Opportunity

Opportunity
Summary:
Description:

Properties:
Name Type Summary
name string
Name
party Party
Party
milestone Milestone
Milestone
description string
Description
durationBasis string Values: [FIXED, HOUR,
Duration Basis DAY, MONTH, YEAR,
WEEK, QUARTER]
duration string
Duration
expectedCloseOn string yyyy-MM-dd

458 | P a g e
 Capsule CRM

Expected Close Date

probability integer(int32)
Winning Probability
value Value Expected value
Expected

Party
Summary: Party
Description:

Properties:
Name Type Summary
id integer(int32) Pick a party.
Party Id

Milestone
Summary: Milestone
Description:

Properties:
Name Type Summary
id integer(int32) Pick a milestone.
Id

Value
Summary: Expected
Description: Expected value

Properties:

459 | P a g e
 Capsule CRM

Name Type Summary

amount integer(int32)
Amount
currency string
Currency

460 | P a g e
 Capsule CRM

CreateOrganisationResponse
Summary:
Description:

Properties:
Name Type Summary
party Party_Response

461 | P a g e
 Capsule CRM

Createorganisation_Request
Summary:
Description:

Properties:
Name Type Summary
party Party

Party
Summary:
Description:

Properties:
Name Type Summary
name string
Name
about string
About
phoneNumbers PhoneNumbers

emailAddresses EmailAddresses

websites Websites

addresses Addresses

tags string Comma-separated list of

Tags tags.

462 | P a g e
 Capsule CRM

type string Organisation type.

Type

PhoneNumbers
Summary:
Description:

Properties:
Name Type Summary
number string
Phone Number
type string Values: [Home, Work,
Phone Type Mobile, Fax, Direct]

EmailAddresses
Summary:
Description:

Properties:
Name Type Summary
address string
Email Address
type string Values: [Home, Work]
Email Type

Websites
Summary:
Description:

463 | P a g e
 Capsule CRM

Properties:
Name Type Summary
address string
Website Address
service string Values: [FEED, FACEBOOK,
Website Service FLICKR, GITHUB,
GOOGLE_PLUS,
INSTAGRAM, LINKED_IN,
PINTEREST, SKYPE,
TWITTER, URL, XING,
YOUTUBE]
type string Values: [Home, Work]
Website Type

Addresses
Summary:
Description:

Properties:
Name Type Summary
street string
Address Street
city string
Address City
state string
Address State
zip string
Address Zip
country string

464 | P a g e
 Capsule CRM

Address Country
type string Values: [Home, Postal,
Address Type Office]

465 | P a g e
 Capsule CRM

CreatePersonResponse
Summary:
Description:

Properties:
Name Type Summary
party Party_Response

466 | P a g e
 Capsule CRM

Createperson_Request
Summary:
Description:

Properties:
Name Type Summary
party Party

Party
Summary:
Description:

Properties:
Name Type Summary
lastName string
Last Name
firstName string
First Name
title string Values: [Mr, Master, Mrs,
Title Miss, Ms, Dr, Prof]
jobTitle string
Job Title
about string
About
organisation string Pick an organisation.
Organisation Id
phoneNumbers PhoneNumbers

467 | P a g e
 Capsule CRM

emailAddresses EmailAddresses

websites Websites

addresses Addresses

tags string Comma-separated list of

Tags tags.
type string Party type.
Type

PhoneNumbers
Summary:
Description:

Properties:
Name Type Summary
number string
Phone Number
type string Values: [Home, Work,
Phone Type Mobile, Fax, Direct]

EmailAddresses
Summary:
Description:

Properties:
Name Type Summary
address string

468 | P a g e
 Capsule CRM

Email Address
type string Values: [Home, Work]
Email Type

Websites
Summary:
Description:

Properties:
Name Type Summary
address string
Website Address
service string Values: [FEED, FACEBOOK,
Website Service FLICKR, GITHUB,
GOOGLE_PLUS,
INSTAGRAM, LINKED_IN,
PINTEREST, SKYPE,
TWITTER, URL, XING,
YOUTUBE]
type string Values: [Home, Work]
Website Type

Addresses
Summary:
Description:

Properties:
Name Type Summary
street string

469 | P a g e
 Capsule CRM

Address Street
city string
Address City
state string
Address State
zip string
Address Zip
country string
Address Country
type string Values: [Home, Postal,
Address Type Office]

470 | P a g e
 Capsule CRM

CreateTaskResponse
Summary:
Description:

Properties:
Name Type Summary
task Task_Response

471 | P a g e
 Capsule CRM

Createtask_Request
Summary:
Description:

Properties:
Name Type Summary
task Task task

Task
Summary:
Description: task

Properties:
Name Type Summary
description string
Description
dueOn string yyyy-MM-dd
Due Date
dueTime string hh:mm:ss
Due Time
detail string
Details
party Party
Party

Party
Summary: Party
Description:

472 | P a g e
 Capsule CRM

Properties:
Name Type Summary
id integer(int32)
Id

473 | P a g e
 Capsule CRM

GetOpportunityResponse
Summary:
Description:

Properties:
Name Type Summary
opportunity Opportunity_Response

474 | P a g e
 Capsule CRM

GetPartyResponse
Summary:
Description:

Properties:
Name Type Summary
party Party_Response

475 | P a g e
 Capsule CRM

Listcurrencies_Response
Summary:
Description:

Properties:
Name Type Summary
currencies array of (CurrenciesItem) currencies
currencies

CurrenciesItem
Summary:
Description:

Properties:
Name Type Summary
code string code
Currency Code
name string name
Currency Name

476 | P a g e
 Capsule CRM

Listmilestones_Response
Summary:
Description:

Properties:
Name Type Summary
milestones array of (MilestonesItem) milestones

MilestonesItem
Summary:
Description:

Properties:
Name Type Summary
complete boolean True if the milestone is
Is Complete complete.
createdAt string(date-time) yyyy-MM-
Create Date-Time ddTHH:mm:ss.fffZ
description string Milestone description.
Description
id integer(int32) Unique id of the milestone.
Milestone Id
name string Name of the milestone.
Milestone Name
probability integer(int32) Percent probability of
Probability winning.
updatedAt string(date-time) yyyy-MM-
Updated Date-Time ddTHH:mm:ss.fffZ

477 | P a g e
 Capsule CRM

478 | P a g e
 Capsule CRM

ListOpportunitiesResponse
Summary:
Description:

Properties:
Name Type Summary
opportunities array of
(Opportunity_Response)

479 | P a g e
 Capsule CRM

Listparties_Response
Summary:
Description:

Properties:
Name Type Summary
parties array of (PartiesItem) party

PartiesItem
Summary:
Description:

Properties:
Name Type Summary
name string Name of the organisation.
Organisation Name
about string Organisation description.
About
createdAt string(date-time) yyyy-MM-
Created Date-Time ddTHH:mm:ss.fffZ
firstName string Person's first name.
First Name
id integer(int32) Unique id of the
Party Id organisation.
jobTitle string Person's job title.
Job Title
lastContactedAt string yyyy-MM-
Last Contacted Date-Time ddTHH:mm:ss.fffZ

480 | P a g e
 Capsule CRM

lastName string Person's last name.

Last Name
organisation string Person's company.
Organisation
pictureURL string Url where the image is
Picture URL located.
title string Person's title.
Title
type string Person or organisation.
Type
updatedAt string(date-time) yyyy-MM-
Updated Date-Time ddTHH:mm:ss.fffZ

481 | P a g e
 Capsule CRM

ListTasksResponse
Summary:
Description:

Properties:
Name Type Summary
tasks array of (Task_Response)

482 | P a g e
 Capsule CRM

Opportunity_Response
Summary:
Description:

Properties:
Name Type Summary
closedOn string yyyy-MM-dd
Closed Date
createdAt string(date-time) yyyy-MM-
Created Date-Time ddTHH:mm:ss.fffZ
description string Opportunity description.
Description
duration string Opportunity duration.
Duration
durationBasis string Basis for the opportunity
Duration Basis duration.
expectedCloseOn string yyyy-MM-dd
Expected Close Date
id integer(int32) Unique id of the
Opportunity Id opportunity.
milestone Milestone Milestone object.

name string Name of the opportunity.

Opportunity Name
owner Owner Represents a reference to
Owner the user object.
party Party Represents a contact
Party object.

483 | P a g e
 Capsule CRM

probability integer(int32) Probability of winning the

Probability opportunity.
updatedAt string(date-time) yyyy-MM-
Updated Date-Time ddTHH:mm:ss.fffZ
value Value Opportunity value object.
Value

Milestone
Summary:
Description: Milestone object.

Properties:
Name Type Summary
id integer(int32) Unique id of the
Milestone Id milestone.
name string Name of the milestone
Milestone Name opportunity is in.

Owner
Summary: Owner
Description: Represents a reference to the user object.

Properties:
Name Type Summary
id integer(int32) Unique id of the user.
Id
name string Name of the user.
Name
username string Username of the user.

484 | P a g e
 Capsule CRM

Username

Party
Summary: Party
Description: Represents a contact object.

Properties:
Name Type Summary
firstName string First name when type is
First Name person.
id integer(int32) Unique id of the party.
Id
lastName string Last name when type is
Last Name person.
pictureURL string Url that represents the
Picture URL profile picture for this
party.
type string Person or organization.
Type

Value
Summary: Value
Description: Opportunity value object.

Properties:
Name Type Summary
amount number(float) amount
Amount the opportunity is
worth.

485 | P a g e
 Capsule CRM

currency string Currency type of the

Currency opportunity.

486 | P a g e
 Capsule CRM

Party_Response
Summary:
Description:

Properties:
Name Type Summary
name string Name of the organisation.
Organisation Name
about string Short description about
About the party.
addresses array of (AddressesItem) Array of addresses.

createdAt string(date-time) yyyy-MM-

Created Date-Time ddTHH:mm:ss.fffZ
emailAddresses array of Array of email addresses.
(EmailAddressesItem)

firstName string Person's first name.

First Name
id integer(int32) Unique id of the party.
Party Id
jobTitle string Person's job title.
Job Title
lastContactedAt string yyyy-MM-
Last Contacted at ddTHH:mm:ss.fffZ
lastName string Person's last name.
Last Name
organisation string Organisation the party is
Organisation associated with.

487 | P a g e
 Capsule CRM

phoneNumbers array of Phone numbers,

(PhoneNumbersItem)

pictureURL string Url that represents the

Picture URL location of the profile
picture for this party.
title string Person's title.
Title
type string Person or organisation.
Type
updatedAt string(date-time) yyyy-MM-
Updated Date-Time ddTHH:mm:ss.fffZ
websites array of (WebsitesItem) websites

AddressesItem
Summary:
Description:

Properties:
Name Type Summary
city string Party address.
City
country string Party address.
Country
state string Party address.
State
street string Party address.
Street

488 | P a g e
 Capsule CRM

type string Party address.

Type
zip string Party address.
Zip

EmailAddressesItem
Summary:
Description:

Properties:
Name Type Summary
address string The actual email address.
Email Address
type string Home or work.
Email Type

PhoneNumbersItem
Summary:
Description:

Properties:
Name Type Summary
number string The actual phone number.
Phone Number
type string Home, work, mobile, fax,
Phone Number Type or direct.

WebsitesItem
Summary:

489 | P a g e
 Capsule CRM

Description:

Properties:
Name Type Summary
address string Account username or
Website Address profile page url.
service string Url, skype, twitter,
Website Service linkedin, facebook, xing,
feed, google_plus, flickr,
github or youtube.
type string Home or work.
Website Type

490 | P a g e
 Capsule CRM

Task_Response
Summary:
Description:

Properties:
Name Type Summary
category Category category
Category
completedAt string yyyy-MM-
Completed Date-Time ddTHH:mm:ss.fffZ
completedBy string Username of the person
Completed By who completed this task.
createdAt string(date-time) yyyy-MM-
Created Date-Time ddTHH:mm:ss.fffZ
description string Short description about
Description the task.
detail string More details about the
Detail task.
dueOn string yyyy-MM-dd
Due Date
dueTime string hh:mm:ss
Due Time
id integer(int32) Unique id of the task.
Task Id
owner Owner User the task is assigned
Owner to.
party Party Represents a person or
Party organisation in Capsule.

491 | P a g e
 Capsule CRM

status string Open, completed or

Status pending.
updatedAt string(date-time) yyyy-MM-
Updated Date-Time ddTHH:mm:ss.fffZ

Category
Summary: Category
Description: category

Properties:
Name Type Summary
colour string Description of the task
Colour category.
id integer(int32) Id of the task category.
Id
name string Name of the task
Name category.

Owner
Summary: Owner
Description: User the task is assigned to.

Properties:
Name Type Summary
id integer(int32) Unique id of the user.
Id
name string Name of the user.
Name
username string Username of the user.

492 | P a g e
 Capsule CRM

Username

Party
Summary: Party
Description: Represents a person or organisation in Capsule.

Properties:
Name Type Summary
firstName string First name, if person.
First Name
id integer(int32) Unique id of the party.
Id
lastName string Last name, if person.
Last Name
pictureURL string Url that represents the
Picture URL location of the profile
picture for this party.
type string Person or organisation.
Type

493 | P a g e
 Capsule CRM

UpdateOpportunityResponse
Summary:
Description:

Properties:
Name Type Summary
opportunity Opportunity_Response

494 | P a g e
 Capsule CRM

Updateopportunity_Request
Summary:
Description:

Properties:
Name Type Summary
opportunity Opportunity

Opportunity
Summary:
Description:

Properties:
Name Type Summary
name string
Name
party Party
Party
milestone Milestone
Milestone
description string
Description
durationBasis string Values: [FIXED, HOUR,
Duration Basis DAY, MONTH, YEAR,
WEEK, QUARTER]
duration string
Duration
expectedCloseOn string yyyy-MM-dd

495 | P a g e
 Capsule CRM

Expected Close Date

probability integer(int32)
Winning Probability
value Value Expected value
Expected

Party
Summary: Party
Description:

Properties:
Name Type Summary
id integer(int32) Pick a party.
Party Id

Milestone
Summary: Milestone
Description:

Properties:
Name Type Summary
id integer(int32) Pick a milestone.
Milestone Id

Value
Summary: Expected
Description: Expected value

Properties:

496 | P a g e
 Capsule CRM

Name Type Summary

amount integer(int32)
Amount
currency string
Currency

497 | P a g e
 Capsule CRM

UpdateOrganisationResponse
Summary:
Description:

Properties:
Name Type Summary
party Party_Response

498 | P a g e
 Capsule CRM

Updateorganisation_Request
Summary:
Description:

Properties:
Name Type Summary
party Party

Party
Summary:
Description:

Properties:
Name Type Summary
name string
Name
about string
About
phoneNumbers PhoneNumbers

emailAddresses EmailAddresses

websites Websites

addresses Addresses

tags string Comma-separated list of

Tags tags.

499 | P a g e
 Capsule CRM

type string Organisation type.

Type

PhoneNumbers
Summary:
Description:

Properties:
Name Type Summary
number string
Phone Number
type string Values: [Home, Work,
Phone Type Mobile, Fax, Direct]

EmailAddresses
Summary:
Description:

Properties:
Name Type Summary
address string
Email Address
type string Values: [Home, Work]
Email Type

Websites
Summary:
Description:

500 | P a g e
 Capsule CRM

Properties:
Name Type Summary
address string
Website Address
service string Values: [FEED, FACEBOOK,
Website Service FLICKR, GITHUB,
GOOGLE_PLUS,
INSTAGRAM, LINKED_IN,
PINTEREST, SKYPE,
TWITTER, URL, XING,
YOUTUBE]
type string Values: [Home, Work]
Website Type

Addresses
Summary:
Description:

Properties:
Name Type Summary
street string
Address Street
city string
Address City
state string
Address State
zip string
Address Zip
country string

501 | P a g e
 Capsule CRM

Address Country
type string Values: [Home, Postal,
Address Type Office]

502 | P a g e
 Capsule CRM

UpdatePersonResponse
Summary:
Description:

Properties:
Name Type Summary
party Party_Response

503 | P a g e
 Capsule CRM

Updateperson_Request
Summary:
Description:

Properties:
Name Type Summary
party Party

Party
Summary:
Description:

Properties:
Name Type Summary
lastName string
Last Name
firstName string
First Name
title string Values: [Mr, Master, Mrs,
Title Miss, Ms, Dr, Prof]
jobTitle string
Job Title
about string
About
organisation string Pick an organisation.
Organisation Id
phoneNumbers PhoneNumbers

504 | P a g e
 Capsule CRM

emailAddresses EmailAddresses

websites Websites

addresses Addresses

tags string Comma-separated list of

Tags tags.
type string Party type.
Type

PhoneNumbers
Summary:
Description:

Properties:
Name Type Summary
number string
Phone Number
type string Values: [Home, Work,
Phone Type Mobile, Fax, Direct]

EmailAddresses
Summary:
Description:

Properties:
Name Type Summary
address string

505 | P a g e
 Capsule CRM

Email Address
type string Values: [Home, Work]
Email Type

Websites
Summary:
Description:

Properties:
Name Type Summary
address string
Website Address
service string Values: [FEED, FACEBOOK,
Website Service FLICKR, GITHUB,
GOOGLE_PLUS,
INSTAGRAM, LINKED_IN,
PINTEREST, SKYPE,
TWITTER, URL, XING,
YOUTUBE]
type string Values: [Home, Work]
Website Type

Addresses
Summary:
Description:

Properties:
Name Type Summary
street string

506 | P a g e
 Capsule CRM

Address Street
city string
Address City
state string
Address State
zip string
Address Zip
country string
Address Country
type string Values: [Home, Postal,
Address Type Office]

507 | P a g e
 Chatter

Chatter
Chatter is an enterprise social network for your company that allows
employees to connect and collaborate in real time.

Status: Preview Tier: Premium Version: 1.0.0

Actions:
Name Summary
CreatePostInGroup Post to a group
(CreatePostInGroupParameterBody
body, string
CreatePostInGroupText)
ListGroupMembers (string List users in a group
group_id)
AddUserToGroup (string group_id, Add user to a group
AddUserToGroupParameterBody
body)
GetUser (string user_id) Get user by ID
GetPost (string post_id) Get post by ID
ListGroups () List groups

Triggers:
Name Summary
TrigNewPostInGroup (string When a post is added to a group
group_id)

Objects:
Name Summary

508 | P a g e
 Chatter

ActorUserResponse Author's
AddUserToGroupParameterBody
CreatePostInGroupParameterBody
CreatePostInGroupResponse
GetPostResponse
GroupMemberResponse
ListGroupMembersResponse
ListGroupsResponse
ListPostsByGroupResponse
OwnerUserResponse Owner's
UserUserResponse User

Actions:
CreatePostInGroup
Summary: Post to a group
Description: Create a new post in an existing group.

Syntax:
Chatter.CreatePostInGroup (CreatePostInGroupParameterBody body,
string CreatePostInGroupText)

Parameters:
Name Type Summar Require Relate
y d d
Action
body CreatePostInGroupParameterB True
ody

509 | P a g e
 Chatter

CreatePostInGroupT string Text True

ext (Post Body) content
of the
post.

Returns:
Type:CreatePostInGroupResponse

ListGroupMembers
Summary: List users in a group
Description: List group membership.

Syntax:
Chatter.ListGroupMembers (string group_id)

Parameters:
Name Type Summary Required Related
Action
group_id string Group True ListGroups
(Group ID)

Returns:
Type:ListGroupMembersResponse

AddUserToGroup
Summary: Add user to a group
Description: Adds a member to an existing group.

Syntax:

510 | P a g e
 Chatter

Chatter.AddUserToGroup (string group_id,

AddUserToGroupParameterBody body)

Parameters:
Name Type Summary Required Related
Action
group_id string Group True ListGroups
(Group ID)
body AddUserToGroupParameterBody True

Returns:
Type:GroupMemberResponse

GetUser
Summary: Get user by ID
Description: Get a user's details by id.

Syntax:
Chatter.GetUser (string user_id)

Parameters:
Name Type Summary Required Related
Action
user_id string True
(User ID)

Returns:
Type:UserUserResponse

511 | P a g e
 Chatter

Summary: User

GetPost
Summary: Get post by ID
Description: Get details of a post by post id.

Syntax:
Chatter.GetPost (string post_id)

Parameters:
Name Type Summary Required Related
Action
post_id string True
(Post ID)

Returns:
Type:GetPostResponse

ListGroups
Summary: List groups
Description: List groups

Syntax:
Chatter.ListGroups ()

Returns:
Type:ListGroupsResponse

512 | P a g e
 Chatter

Triggers:
Trigger TrigNewPostInGroup
Summary: When a post is added to a group
Description: Triggers when a new post is added to an existing group.

Syntax:
Chatter.TrigNewPostInGroup (string group_id)

Parameters:
Name Type Summary Required Related
Action
group_id string Group True ListGroups
(Group ID)

Returns:
Type:ListPostsByGroupResponse

513 | P a g e
 Chatter

ActorUserResponse
Summary: Author's
Description:

Properties:
Name Type Summary
companyName string Name of the company.
Company Name
displayName string User name of the author.
Display Name
id string Unique identifier of the
User ID author.
name string First and last name of the
Name author.
photo Photo
Photo
title string Title of the author.
Title

Photo
Summary: Photo
Description:

Properties:
Name Type Summary
largePhotoUrl string Profile image of the
(large) author.
mediumPhotoUrl string Profile image of the
(medium) author.

514 | P a g e
 Chatter

smallPhotoUrl string Profile image of the

(small) author.

515 | P a g e
 Chatter

AddUserToGroupParameterBody
Summary:
Description:

Properties:
Name Type Summary
userId string Unique id of the user.
Salesforce User ID

516 | P a g e
 Chatter

CreatePostInGroupParameterBody
Summary:
Description:

Properties:
Name Type Summary
subjectId string Group
Group ID

517 | P a g e
 Chatter

CreatePostInGroupResponse
Summary:
Description:

Properties:
Name Type Summary
actor ActorUserResponse
Author's
body Body
Post Body
createdDate string(date-time) Date-Time in ISO-8601
Date Posted format.
header Header
Header
id string Unique id of the feed
ID item.
modifiedDate string(date-time) Date-Time in ISO-8601
Modified date format.
parent Parent
Parent
type string Type of the post.
Type
visibility string Who can see the post.
Visbility

Body
Summary: Post Body
Description:

518 | P a g e
 Chatter

Properties:
Name Type Summary
isRichText boolean True if the message is in
Is Rich Text rich text format.
text string Display-ready text of the
Text message.

Header
Summary: Header
Description:

Properties:
Name Type Summary
isRichText string True if the header is in rich
Is Rich Text text format.
text string Title of the post.
Text

Parent
Summary: Parent
Description:

Properties:
Name Type Summary
description string Description of the parent
Description object.
id string Unique id of the parent
ID object.

519 | P a g e
 Chatter

name string Name of the parent

Name object.
owner OwnerUserResponse
Owner's
type string Type of the parent object.
Type
visibility string Who can see the parent
Visbility object.

520 | P a g e
 Chatter

GetPostResponse
Summary:
Description:

Properties:
Name Type Summary
actor ActorUserResponse
Author's
body Body
Post Body
createdDate string(date-time) Date-Time in ISO-8601
Date Posted format.
header Header
Header
id string Unique id of the feed
ID item.
modifiedDate string(date-time) Date-Time in ISO-8601
Modified Date format.
parent Parent
Parent
type string Type of the post.
Type
visibility string Who can see the post.
Visbility

Body
Summary: Post Body
Description:

521 | P a g e
 Chatter

Properties:
Name Type Summary
isRichText boolean True if the message is in
Is Rich Text rich text format.
text string Display-ready text of the
Text post.

Header
Summary: Header
Description:

Properties:
Name Type Summary
isRichText string True if the header is in rich
Is Rich Text text format.
text string Title of the post.
Text

Parent
Summary: Parent
Description:

Properties:
Name Type Summary
description string Description of the parent
Description object.
id string Unique id of the parent
ID object.

522 | P a g e
 Chatter

name string Name of the parent

Name object.
owner OwnerUserResponse
Owner's
type string Type of the parent object.
Type
visibility string Who can see the parent
Visbility object.

523 | P a g e
 Chatter

GroupMemberResponse
Summary:
Description:

Properties:
Name Type Summary
id string Unique identifier of the
Member ID member.
role string Member's role in the
Role group.
url string Link to member's user
URL profile.
user UserUserResponse
User

524 | P a g e
 Chatter

ListGroupMembersResponse
Summary:
Description:

Properties:
Name Type Summary
members array of
(GroupMemberResponse)

totalMemberCount integer(int32) Number of members in

Total member count the group.

525 | P a g e
 Chatter

ListGroupsResponse
Summary:
Description:

Properties:
Name Type Summary
groups array of (GroupsItem)

GroupsItem
Summary:
Description:

Properties:
Name Type Summary
id string

name string

526 | P a g e
 Chatter

ListPostsByGroupResponse
Summary:
Description:

Properties:
Name Type Summary
elements array of (ElementsItem)

ElementsItem
Summary:
Description:

Properties:
Name Type Summary
actor ActorUserResponse
Author's
body Body
Post Body
createdDate string(date-time) Date-Time in ISO-8601
Date Posted format.
header Header
Header
id string Unique id of the feed
ID item.
modifiedDate string(date-time) Date-Time in ISO-8601
Modified Date format.
parent Parent
Parent

527 | P a g e
 Chatter

type string Type of the post.

Type
visibility string Who can see the post.
Visbility

Body
Summary: Post Body
Description:

Properties:
Name Type Summary
isRichText boolean True if the message is in
Is Rich Text rich text format.
text string Display-ready text of the
Text message.

Header
Summary: Header
Description:

Properties:
Name Type Summary
isRichText string True if the header is in rich
Is Rich Text text format.
text string Title of the post.
Text

Parent
Summary: Parent

528 | P a g e
 Chatter

Description:

Properties:
Name Type Summary
description string Description of the parent
Description object.
id string Unique id of the parent
ID object.
name string Name of the parent
Name object.
owner OwnerUserResponse
Owner's
type string Type of the parent object.
Type
visibility string Who can see the parent
Visbility object.

529 | P a g e
 Chatter

OwnerUserResponse
Summary: Owner's
Description:

Properties:
Name Type Summary
companyName string Name of the company.
Company Name
displayName string User name of the owner.
Display Name
id string Unique identifier of the
User ID owner.
name string First and last name of the
Name owner.
photo Photo
Photo
title string Title of the owner.
Title

Photo
Summary: Photo
Description:

Properties:
Name Type Summary
largePhotoUrl string Profile image of the
(large) owner.
mediumPhotoUrl string Profile image of the
(medium) owner.

530 | P a g e
 Chatter

smallPhotoUrl string Profile image of the

(small) owner.

531 | P a g e
 Chatter

UserUserResponse
Summary: User
Description:

Properties:
Name Type Summary
companyName string Name of the company.
Company Name
displayName string User's display name.
Display Name
id string Unique identifier of the
ID user.
name string First and last name of the
Name user.
photo Photo
Photo
title string User's title.
Title

Photo
Summary: Photo
Description:

Properties:
Name Type Summary
largePhotoUrl string Profile image of the user.
(large)
mediumPhotoUrl string Profile image of the user.
(medium)

532 | P a g e
 Chatter

smallPhotoUrl string Profile image of the user.

(small)

533 | P a g e
 Computer Vision API

Computer Vision API

Extract rich information from images to categorize and process visual data—
and protect your users from unwanted content with this Azure Cognitive
Service.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
GetImageSchema (string format) Get Request Body Parameters
RecognizeDomainSpecificContent (string model, Recognize Domain Specific
string format, Content
RecognizeDomainSpecificContentParameterImage
Image)
TagImage (string format, Tag Image
TagImageParameterImage Image)
OCR ([internal][Optional]string language, Optical Character Recognition
[internal][Optional]boolean detectOrientation, (OCR) to JSON
string format, OCRParameterImage Image)
OCRText ([internal][Optional]string language, Optical Character Recognition
[internal][Optional]boolean detectOrientation, (OCR) to Text
string format, OCRTextParameterImage Image)
AnalyzeImage ([advanced][Optional]string Analyze Image
language, [internal][Optional]string
visualFeatures, string format,
AnalyzeImageParameterImage Image)
GetThumbnail (number width, number height, Generate Thumbnail
[advanced][Optional]boolean smartCropping,

534 | P a g e
 Computer Vision API

string format, GetThumbnailParameterImage

Image)
DescribeImage ([advanced][Optional]number Describe Image
maxCandidates, string format,
DescribeImageParameterImage Image)

Triggers:
Name Summary

Objects:
Name Summary
AnalyzeImageParameterImage
AnalyzeResponse
DescribeImageParameterImage
DescribeResponse
DomainModelResponse
GetImageSchemaResponse
GetThumbnailParameterImage
OCRJsonResponse JSON Response
OCRParameterImage
OCRTextParameterImage
OCRTextResponse
RecognizeDomainSpecificContentParameterImage
TagImageParameterImage
TagResponse

535 | P a g e
 Computer Vision API

Actions:
GetImageSchema
Summary: Get Request Body Parameters
Description: Return the schema for the request body format desired.

Syntax:
ComputerVisionAPI.GetImageSchema (string format)

Parameters:
Name Type Summary Required Related
Action
format string Source of the True
(Image image - either
Source)Values: included or by
[Image reference url.
Content,
Image URL]

Returns:
Type:GetImageSchemaResponse

RecognizeDomainSpecificContent
Summary: Recognize Domain Specific Content
Description: Recognize celebrities or landmarks in an image.

Syntax:
ComputerVisionAPI.RecognizeDomainSpecificContent (string model,
string format, RecognizeDomainSpecificContentParameterImage
Image)

536 | P a g e
 Computer Vision API

Parameters:
Name Type Summar Require Relate
y d d
Action
mode string Supporte True
l (Domain Model)Values: [Celebrities, d
Landmarks] domain-
specific
model to
recogniz
e in
image.
forma string Source True
t (Image Source)Values: [Image Content, of the
Image URL] image -
either
included
or by
referenc
e url.
Image RecognizeDomainSpecificContentParameterI True
mage

Returns:
Type:DomainModelResponse

537 | P a g e
 Computer Vision API

TagImage
Summary: Tag Image
Description: Generates a list of words, or tags, that are relevant to the content of the
supplied image.

Syntax:
ComputerVisionAPI.TagImage (string format,
TagImageParameterImage Image)

Parameters:
Name Type Summary Required Related
Action
format string Source of the True
(Image Source)Values: image -
[Image Content, Image either
URL] included or
by reference
url.
Image TagImageParameterImage True

Returns:
Type:TagResponse

OCR
Summary: Optical Character Recognition (OCR) to JSON
Description: Optical Character Recognition (OCR) detects text in an image and extracts
the recognized characters into a machine-usable JSON stream.

538 | P a g e
 Computer Vision API

Syntax:
ComputerVisionAPI.OCR ([internal][Optional]string language,
[internal][Optional]boolean detectOrientation, string format,
OCRParameterImage Image)

Parameters:
Name Type Summary Required Related
Action
language string The language False
(Language) code of the
text to be
detected in
the image.
detectOrientation boolean he BCP-47 False
(Detect Orientation) language
code of the
text to be
detected in
the image.
format string Source of the True
(Image image -
Source)Values: either
[Image Content, included or
Image URL] by reference
url.
Image OCRParameterImage True

Returns:

539 | P a g e
 Computer Vision API

Type:OCRJsonResponse
Summary: JSON Response

OCRText
Summary: Optical Character Recognition (OCR) to Text
Description: Optical Character Recognition (OCR) detects text in an image and extracts
the recognized characters into a text file.

Syntax:
ComputerVisionAPI.OCRText ([internal][Optional]string language,
[internal][Optional]boolean detectOrientation, string format,
OCRTextParameterImage Image)

Parameters:
Name Type Summary Required Related
Action
language string The False
(Language) language
code of the
text to be
detected in
the image.
detectOrientation boolean he BCP-47 False
(Detect Orientation) language
code of the
text to be
detected in
the image.

540 | P a g e
 Computer Vision API

format string Source of True

(Image Source)Values: the image -
[Image Content, Image either
URL] included or
by
reference
url.
Image OCRTextParameterImage True

Returns:
Type:OCRTextResponse

AnalyzeImage
Summary: Analyze Image
Description: This operation extracts a rich set of visual features based on the image
content.

Syntax:
ComputerVisionAPI.AnalyzeImage ([advanced][Optional]string
language, [internal][Optional]string visualFeatures, string
format, AnalyzeImageParameterImage Image)

Parameters:
Name Type Summary Required Related
Action
language string The service False
(Language)Values: [en, zh] will return
recognition

541 | P a g e
 Computer Vision API

results in
specified
language.
visualFeatures string A string False
(Visual Feature Options) indicating
what visual
feature
types to
return.
Multiple
values
should be
comma-
separated.
format string Source of True
(Image Source)Values: [Image the image -
Content, Image URL] either
included or
by
reference
url.
Image AnalyzeImageParameterImage True

Returns:
Type:AnalyzeResponse

GetThumbnail
Summary: Generate Thumbnail

542 | P a g e
 Computer Vision API

Description: This operation generates a thumbnail image with the user-specified width
and height.

Syntax:
ComputerVisionAPI.GetThumbnail (number width, number height,
[advanced][Optional]boolean smartCropping, string format,
GetThumbnailParameterImage Image)

Parameters:
Name Type Summary Require Relate
d d
Action
width number Width of the True
(Thumbnail Width) generated
thumbnail -
recommende
d is 50
height number Height of the True
(Thumbnail Height) generated
thumbnail -
recommende
d is 50
smartCroppin boolean Boolean flag False
g (Smart Cropping) for enabling
smart
cropping
format string Source of the True
(Image Source)Values: [Image image - either
Content, Image URL]

543 | P a g e
 Computer Vision API

included or by
reference url.
Image GetThumbnailParameterImag True
e

Returns:
Type:string(binary)
Summary: Thumbnail
Description: Generated thumbnail image

DescribeImage
Summary: Describe Image
Description: This operation generates a description of an image in human readable
language with complete sentences.

Syntax:
ComputerVisionAPI.DescribeImage ([advanced][Optional]number
maxCandidates, string format, DescribeImageParameterImage Image)

Parameters:
Name Type Summary Required Related
Action
maxCandidates number Maximum False
(Max Candidates) number of
candidate
descriptions
to be
returned.

544 | P a g e
 Computer Vision API

format string Source of True

(Image Source)Values: [Image the image -
Content, Image URL] either
included or
by
reference
url.
Image DescribeImageParameterImage True

Returns:
Type:DescribeResponse

545 | P a g e
 Computer Vision API

AnalyzeImageParameterImage
Summary:
Description:

Properties:
Name Type Summary

546 | P a g e
 Computer Vision API

AnalyzeResponse
Summary:
Description:

Properties:
Name Type Summary
categories array of (CategoriesItem) Categories identified from
the image
description Description Properties to describe the
image analyzed
tags array of (TagsItem) Tags identified with
confidence scores.

CategoriesItem
Summary:
Description:

Properties:
Name Type Summary
name string Name of the category
Category Name identified from the image
score number(float) Confidence Score for the
Category Confidence Score image category

Description
Summary:
Description: Properties to describe the image analyzed

Properties:

547 | P a g e
 Computer Vision API

Name Type Summary

captions array of (CaptionsItem) List of captions generated
Captions from the image
tags array of (string) Collection of tag names.
Tag Names

CaptionsItem
Summary:
Description:

Properties:
Name Type Summary
confidence number(float) Confidence score of the
Caption Confidence Score image caption
text string Text caption generated
Caption Text from the image

TagsItem
Summary:
Description:

Properties:
Name Type Summary
confidence number(float) Confidence score for the
Tag Confidence Score identified tags.
name string Name of the tag
Tag Name identified.

548 | P a g e
 Computer Vision API

DescribeImageParameterImage
Summary:
Description:

Properties:
Name Type Summary

549 | P a g e
 Computer Vision API

DescribeResponse
Summary:
Description:

Properties:
Name Type Summary
description Description Properties to describe the
image analyzed

Description
Summary:
Description: Properties to describe the image analyzed

Properties:
Name Type Summary
captions array of (CaptionsItem) List of captions generated
Captions from the image
tags array of (string) Collection of tag names.
Tag Names

CaptionsItem
Summary:
Description:

Properties:
Name Type Summary
confidence number(float) Confidence score of the
Caption Confidence Score image caption

550 | P a g e
 Computer Vision API

text string Text caption generated

Caption Text from the image

551 | P a g e
 Computer Vision API

DomainModelResponse
Summary:
Description:

Properties:
Name Type Summary
result Result Computer Vision Result

Result
Summary:
Description: Computer Vision Result

Properties:
Name Type Summary
celebrities array of (CelebritiesItem) Recognized celebrities in
image
landmarks array of (LandmarksItem) Recognized landmarks in
image

CelebritiesItem
Summary:
Description:

Properties:
Name Type Summary
confidence number(float) Confidence score that
Celebrity Confidence image is of celebrity

552 | P a g e
 Computer Vision API

name string Name of the recognized

Celebrity Name celebrity

LandmarksItem
Summary:
Description:

Properties:
Name Type Summary
confidence number(float) Confidence score that
Landmark Confidence image is of landmark
name string Name of the identified
Landmark Name landmark

553 | P a g e
 Computer Vision API

GetImageSchemaResponse
Summary:
Description:

Properties:
Name Type Summary
schema Schema

Schema
Summary:
Description:

Properties:
Name Type Summary

554 | P a g e
 Computer Vision API

GetThumbnailParameterImage
Summary:
Description:

Properties:
Name Type Summary

555 | P a g e
 Computer Vision API

OCRJsonResponse
Summary: JSON Response
Description:

Properties:
Name Type Summary
language string Detected language of the
Text Language image text.
regions array of (RegionsItem) Text regions returned.
Regions Array

RegionsItem
Summary:
Description:

Properties:
Name Type Summary

556 | P a g e
 Computer Vision API

OCRParameterImage
Summary:
Description:

Properties:
Name Type Summary

557 | P a g e
 Computer Vision API

OCRTextParameterImage
Summary:
Description:

Properties:
Name Type Summary

558 | P a g e
 Computer Vision API

OCRTextResponse
Summary:
Description:

Properties:
Name Type Summary
text string Text detected in the image
Detected Text analyzed

559 | P a g e
 Computer Vision API

RecognizeDomainSpecificContentParameterImage
Summary:
Description:

Properties:
Name Type Summary

560 | P a g e
 Computer Vision API

TagImageParameterImage
Summary:
Description:

Properties:
Name Type Summary

561 | P a g e
 Computer Vision API

TagResponse
Summary:
Description:

Properties:
Name Type Summary
tags array of (TagsItem) Set of tags returned from
the picture analysis.

TagsItem
Summary:
Description:

Properties:
Name Type Summary
confidence number(float) Confidence score of the
Tag Confidence Score identified tag.
name string Name of the tag
Tag Name identified.

562 | P a g e
 Disqus

Disqus
Disqus is a service for web comments and discussions. Disqus makes
commenting easier and more interactive, helping publishers power online
discussions.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
CreatePost (string thread, Create a comment
string message)
ReplyToPost (string parent, Reply to a comment
string message)
RemovePost (string post) Remove a comment
GetFollowedForums Get followed channels
([internal][Optional]string
order,
[internal][Optional]integer
limit)
SubscribeToThread (string Follow a discussion
thread)
OpenThread (string thread) Open a discussion
CloseThread (string thread) Close a discussion
RecommendThread (string Recommend a discussion
thread, [internal]string vote)
GetForumThreads (string Get discussions in a channel
forum,
[internal][Optional]string

563 | P a g e
 Disqus

order,
[internal][Optional]integer
limit)

Triggers:
Name Summary
OnPostCreated (string forum, When a comment is created
[Optional]string thread,
[internal][Optional]string
order,
[internal][Optional]integer
limit)
OnThreadCreated (string When a discussion is created
forum,
[internal][Optional]string
order,
[internal][Optional]integer
limit)

Objects:
Name Summary
Author
CreatePostResponse
EmptyResponse
Forum
OperationResultResponse
Post
RecommendThreadResponse

564 | P a g e
 Disqus

Thread

Actions:
CreatePost
Summary: Create a comment
Description: Create a comment on a specified thread.

Syntax:
Disqus.CreatePost (string thread, string message)

Parameters:
Name Type Summary Required Related
Action
thread string True
(Discussion
Id)
message string True
(Message)

Returns:
Type:CreatePostResponse

ReplyToPost
Summary: Reply to a comment
Description: Reply to a specified comment.

Syntax:
Disqus.ReplyToPost (string parent, string message)

565 | P a g e
 Disqus

Parameters:
Name Type Summary Required Related
Action
parent string True
(Parent
Comment
Id)
message string True
(Message)

Returns:
Type:CreatePostResponse

RemovePost
Summary: Remove a comment
Description: Remove a comment.

Syntax:
Disqus.RemovePost (string post)

Parameters:
Name Type Summary Required Related
Action
post string True
(Comment
Id)

Returns:
Type:OperationResultResponse

566 | P a g e
 Disqus

GetFollowedForums
Summary: Get followed channels
Description: Get a list of the channels the current user follows.

Syntax:
Disqus.GetFollowedForums ([internal][Optional]string order,
[internal][Optional]integer limit)

Parameters:
Name Type Summary Required Related
Action
order string False

limit integer(int32) False

Returns:
Type:array of (Forum)

SubscribeToThread
Summary: Follow a discussion
Description: Follow a discussion.

Syntax:
Disqus.SubscribeToThread (string thread)

Parameters:

567 | P a g e
 Disqus

Name Type Summary Required Related

Action
thread string True
(Discussion
Id)

Returns:
Type:EmptyResponse

OpenThread
Summary: Open a discussion
Description: Opens a new discussion (for moderators of this forum only).

Syntax:
Disqus.OpenThread (string thread)

Parameters:
Name Type Summary Required Related
Action
thread string True
(Discussion
Id)

Returns:
Type:OperationResultResponse

CloseThread
Summary: Close a discussion
Description: Closes a discussion (for moderators of this forum only).

568 | P a g e
 Disqus

Syntax:
Disqus.CloseThread (string thread)

Parameters:
Name Type Summary Required Related
Action
thread string True
(Discussion
Id)

Returns:
Type:OperationResultResponse

RecommendThread
Summary: Recommend a discussion
Description: Recommend a discussion.

Syntax:
Disqus.RecommendThread (string thread, [internal]string vote)

Parameters:
Name Type Summary Required Related
Action
thread string True
(Discussion
Id)
vote string True

569 | P a g e
 Disqus

Returns:
Type:RecommendThreadResponse

GetForumThreads
Summary: Get discussions in a channel
Description: Returns a list of discussions in the specified channel.

Syntax:
Disqus.GetForumThreads (string forum, [internal][Optional]string
order, [internal][Optional]integer limit)

Parameters:
Name Type Summary Required Related Action
forum string True GetFollowedForums
(Channel)
order string False

limit integer(int32) False

Returns:
Type:array of (Thread)

Triggers:
Trigger OnPostCreated
Summary: When a comment is created
Description: Triggers a flow when a comment is created on a specified discussion.

570 | P a g e
 Disqus

Syntax:
Disqus.OnPostCreated (string forum, [Optional]string thread,
[internal][Optional]string order, [internal][Optional]integer
limit)

Parameters:
Name Type Summary Required Related Action
forum string True GetFollowedForums
(Channel)
thread string False GetForumThreads
(Discussion)
order string False

limit integer(int32) False

Returns:
Type:array of (Post)

Trigger OnThreadCreated
Summary: When a discussion is created
Description: Triggers a flow when a discussion is created on a specified forum.

Syntax:
Disqus.OnThreadCreated (string forum, [internal][Optional]string
order, [internal][Optional]integer limit)

Parameters:

571 | P a g e
 Disqus

Name Type Summary Required Related Action

forum string True GetFollowedForums
(Channel)
order string False

limit integer(int32) False

Returns:
Type:array of (Thread)

572 | P a g e
 Disqus

Author
Summary:
Description:

Properties:
Name Type Summary
id string The id of the author.
Author Id
joinedAt string(date-time) The date/time the author
Author Join Date joined Disqus.
isVerified boolean Set to true if the author is
Is Verified Author verified.
username string The username of the
Author Username author.
about string Details about the author.
About the Author
name string The name of the author.
Author Name
profileUrl string The URL of the author
Author Profile URL profile.
isAnonymous boolean Set to true if the author is
Is Anonymous Author anonymous.

573 | P a g e
 Disqus

CreatePostResponse
Summary:
Description:

Properties:
Name Type Summary
response Post

574 | P a g e
 Disqus

EmptyResponse
Summary:
Description:

Properties:
Name Type Summary
response Response

Response
Summary:
Description:

Properties:
Name Type Summary

575 | P a g e
 Disqus

Forum
Summary:
Description:

Properties:
Name Type Summary
description string The description of the
HTML Description channel in HTML.
url string The URL of the channel.
Channel URL
raw_description string The description of the
Description channel in raw format
(not HTML).
language string Language Code
Language
daysAlive integer(int32) The number of days the
Days Alive channel has been alive.
id string The id of the channel.
Channel Id
createdAt string(date-time) The date/time the
Created At channel was created at.
name string The name of the channel.
Channel Name

576 | P a g e
 Disqus

OperationResultResponse
Summary:
Description:

Properties:
Name Type Summary
response array of (ResponseItem)

ResponseItem
Summary:
Description:

Properties:
Name Type Summary
id string

577 | P a g e
 Disqus

Post
Summary:
Description:

Properties:
Name Type Summary
dislikes integer(int32) Number of dislikes.
Dislikes
thread string The id of the discussion.
Discussion Id
likes integer(int32) Number of likes.
Likes
message string The message text in
HTML Message HTML.
id string The id of the comment.
Comment Id
author Author

isSpam boolean
Is Spam
createdAt string(date-time) The date/time the
Created At comment was created at.
parent integer(int32) The id of the parent
Parent Comment Id discussion.
isApproved boolean Set to true if the
Is Approved moderator has approved
the comment.

578 | P a g e
 Disqus

isFlagged boolean Set to true if the

Is Flagged comment has been
flagged.
raw_message string The message text in raw
Message format (not HTML).
isHighlighted boolean Set to true if the
Is Featured comment is featured.
forum string The id of the channel.
Channel Id
isEdited boolean Set to true if the
Is Edited comment is edited.

579 | P a g e
 Disqus

RecommendThreadResponse
Summary:
Description:

Properties:
Name Type Summary
response Response

Response
Summary:
Description:

Properties:
Name Type Summary
thread Thread

vote integer(int32) Result after voting

Vote

580 | P a g e
 Disqus

Thread
Summary:
Description:

Properties:
Name Type Summary
feed string The URL of the RSS feed.
RSS Feed
dislikes integer(int32) The number of dislikes on
Dislikes the discussion.
likes integer(int32) The number of likes on
Likes the discussion.
message string The message text in
HTML Message HTML.
id string The id of the discussion.
Discussion Id
author string The id of the author.
Author Id
createdAt string(date-time) The date/time the
Created At discussion was created at.
raw_message string The message text in raw
Message format (not HTML).
link string The link to the discussion.
Link
forum string The id of the channel.
Channel Id
clean_title string

581 | P a g e
 Disqus

posts integer(int32) The number of comments

Number of comments on this discussion.
title string The title of the discussion.
Title

582 | P a g e
 DocuSign

DocuSign
DocuSign is the easiest and most secure way to sign and get documents
signed. With over 50 million users worldwide, DocuSign is the most widely
used eSignature and Digital Transaction Management platform in the world.

Status: Preview Tier: Premium Version: 1.0

Actions:
Name Summary
SendEnvelope (string accountId, string Send envelope using template
templateId, string status, DynamicSigners
signers)
SendDraftEnvelope (string accountId, string Send envelope
envelopeId)
GetRecipientStatus (string accountId, string List recipients
folderId, string envelopeId)
AddRecipientToEnvelope (string accountId, Add recipient to an envelope
string envelopeId, string
AddRecipientToEnvelopeName, string
AddRecipientToEnvelopeEmail,
AddRecipientToEnvelopeRequest
newRecipient)
RemoveRecipientFromEnvelope (string Remove recipient from an envelope
accountId, string folderId, string
envelopeId, string
RemoveRecipientFromEnvelopeRecipientId)
GetLoginAccounts () Login
GetEnvelopeTemplates (string accountId) List templates

583 | P a g e
 DocuSign

GetFolderList (string accountId) List folders

GetFolderEnvelopeList (string accountId, List envelopes
string folderId)
GetEnvelopeDocumentList (string List documents
accountId, string folderId, string
envelopeId)
GetDynamicSigners (string accountId, string Get the signers of a template in
templateId) dynamic schema format.

Triggers:
Name Summary
OnEnvelopeStatusChanges When an envelope status changes
(string accountId,
[Optional]string status)

Objects:
Name Summary
AddRecipientToEnvelopeRequest
DynamicSigners
Envelope
EnvelopeDocument
EnvelopeTemplate
Folder
FolderItem
GetLoginAccountsResponse
ListDocumentsResponse
ListEnvelopesResponse
ListFoldersResponse

584 | P a g e
 DocuSign

ListRecipientsResponse
ListTemplatesResponse
LoginAccount
OnEnvelopeStatusChangesResponse
SendDraftEnvelopeResponse
SendEnvelopeResponse
Signer
SignerRequest

Actions:
SendEnvelope
Summary: Send envelope using template
Description: Send a new envelope using a specified template.

Syntax:
DocuSign.SendEnvelope (string accountId, string templateId,
string status, DynamicSigners signers)

Parameters:
Name Type Summary Required Related Action
accountId string Account id True GetLoginAccounts
(Account)
templateId string Template id True GetEnvelopeTemplates
(Template)
status string Envelope True
(Envelope status
status)Values:
[Sent, Created]

585 | P a g e
 DocuSign

signers DynamicSigners An object True

that
represents
signers
based on a
template.

Returns:
Type:SendEnvelopeResponse

SendDraftEnvelope
Summary: Send envelope
Description: Send an existing envelope.

Syntax:
DocuSign.SendDraftEnvelope (string accountId, string envelopeId)

Parameters:
Name Type Summary Required Related Action
accountId string Account id True GetLoginAccounts
(Account)
envelopeId string Envelope id True
(Envelope)

Returns:
Type:SendDraftEnvelopeResponse

GetRecipientStatus
Summary: List recipients

586 | P a g e
 DocuSign

Description: List recipients for a specific envelope.

Syntax:
DocuSign.GetRecipientStatus (string accountId, string folderId,
string envelopeId)

Parameters:
Name Type Summary Required Related Action
accountId string Account id True GetLoginAccounts
(Account)
folderId string Folder id True GetFolderList
(Folder)
envelopeId string Envelope id True GetFolderEnvelopeList
(Envelope)

Returns:
Type:ListRecipientsResponse

AddRecipientToEnvelope
Summary: Add recipient to an envelope
Description: Add recipient to an envelope

Syntax:
DocuSign.AddRecipientToEnvelope (string accountId, string
envelopeId, string AddRecipientToEnvelopeName, string
AddRecipientToEnvelopeEmail, AddRecipientToEnvelopeRequest
newRecipient)

Parameters:

587 | P a g e
 DocuSign

Name Type Summ Requir Related

ary ed Action
accountId string Accou True GetLoginAcc
(Account) nt id ounts
envelopeId string Envelo True
(Envelope) pe id
AddRecipientToEnvelo string The True
peName (Signer Name) name
of the
recipie
nt.
AddRecipientToEnvelo string The True
peEmail (Signer Email) email
of the
recipie
nt.
newRecipient AddRecipientToEnvelop True
eRequest

Returns:
Type:ListRecipientsResponse

RemoveRecipientFromEnvelope
Summary: Remove recipient from an envelope
Description: Remove recipient from an envelope

Syntax:

588 | P a g e
 DocuSign

DocuSign.RemoveRecipientFromEnvelope (string accountId, string

folderId, string envelopeId, string
RemoveRecipientFromEnvelopeRecipientId)

Parameters:
Name Type Summa Requir Related Action
ry ed
accountId string Accoun True GetLoginAccount
(Accoun t id s
t)
folderId string Folder True GetFolderList
(Folder) id
envelopeId string Envelo True GetFolderEnvelop
(Envelo pe id eList
pe)
RemoveRecipientFromEnvelopeR string Recipie True GetRecipientStat
ecipientId (Recipie nt id us
nt)

Returns:
Type:ListRecipientsResponse

GetLoginAccounts
Summary: Login
Description: Login

Syntax:
DocuSign.GetLoginAccounts ()

589 | P a g e
 DocuSign

Returns:
Type:GetLoginAccountsResponse

GetEnvelopeTemplates
Summary: List templates
Description: List templates for a specific account.

Syntax:
DocuSign.GetEnvelopeTemplates (string accountId)

Parameters:
Name Type Summary Required Related Action
accountId string Account id True GetLoginAccounts
(Account)

Returns:
Type:ListTemplatesResponse

GetFolderList
Summary: List folders
Description: List folders for a specific account.

Syntax:
DocuSign.GetFolderList (string accountId)

Parameters:
Name Type Summary Required Related Action
accountId string Account id True GetLoginAccounts

590 | P a g e
 DocuSign

(Account)

Returns:
Type:ListFoldersResponse

GetFolderEnvelopeList
Summary: List envelopes
Description: List envelopes under a particular folder.

Syntax:
DocuSign.GetFolderEnvelopeList (string accountId, string
folderId)

Parameters:
Name Type Summary Required Related Action
accountId string Account id True GetLoginAccounts
(Account)
folderId string Folder id True GetFolderList
(Folder)

Returns:
Type:ListEnvelopesResponse

GetEnvelopeDocumentList
Summary: List documents
Description: List documents in an envelope.

Syntax:

591 | P a g e
 DocuSign

DocuSign.GetEnvelopeDocumentList (string accountId, string

folderId, string envelopeId)

Parameters:
Name Type Summary Required Related Action
accountId string Account id True GetLoginAccounts
(Account)
folderId string Folder id True GetFolderList
(Folder)
envelopeId string Envelope id True GetFolderEnvelopeList
(Envelope)

Returns:
Type:ListDocumentsResponse

GetDynamicSigners
Summary: Get the signers of a template in dynamic schema format.
Description: Get the signers of a template in dynamic schema format.

Syntax:
DocuSign.GetDynamicSigners (string accountId, string templateId)

Parameters:
Name Type Summary Required Related
Action
accountId string Account to get True
(Account the signers for.
Id)

592 | P a g e
 DocuSign

templateId string Template to get True

(Template the signers for.
Id)

Returns:
Type:string

Triggers:
Trigger OnEnvelopeStatusChanges
Summary: When an envelope status changes
Description: Triggers a new flow when an envelope status changes.

Syntax:
DocuSign.OnEnvelopeStatusChanges (string accountId,
[Optional]string status)

Parameters:
Name Type Summary Required Related Action
accountId string Account id True GetLoginAccounts
(Account)
status string False
(Envelope
status)Values:
[Any, Voided,
Created,
Deleted,
Sent,
Delivered,
Signed,

593 | P a g e
 DocuSign

Completed,
Declined,
TimedOut,
Template,
Processing]

Returns:
Type:OnEnvelopeStatusChangesResponse

594 | P a g e
 DocuSign

AddRecipientToEnvelopeRequest
Summary:
Description:

Properties:
Name Type Summary
signers array of (SignerRequest)
Signer

595 | P a g e
 DocuSign

DynamicSigners
Summary:
Description: An object that represents signers based on a template.

Properties:
Name Type Summary

596 | P a g e
 DocuSign

Envelope
Summary:
Description:

Properties:
Name Type Summary
documentsUri string The URI for the document
Documents URI in DocuSign.
envelopeId string The id of the envelope.
Envelope Id
envelopeUri string The URI for the envelope
Envelope URI in DocuSign.
notificationUri string The URI for the
Notification URI notifications.
recipientsUri string The URI for the recipients
Recipients URI of the envelope in
DocuSign.
status string The status of the
Status envelope.
statusChangedDateTime string The datetime the status
Status Changed Datetime changed.

597 | P a g e
 DocuSign

EnvelopeDocument
Summary:
Description:

Properties:
Name Type Summary
documentId string The id of the document.
Document Id
name string The name of the
Name document.

598 | P a g e
 DocuSign

EnvelopeTemplate
Summary:
Description:

Properties:
Name Type Summary
templateId string The id of the template.
Template Id
name string The name of the template.
Name

599 | P a g e
 DocuSign

Folder
Summary:
Description:

Properties:
Name Type Summary
name string The name of the folder.
Name
folderId string The id of the folder.
Folder Id

600 | P a g e
 DocuSign

FolderItem
Summary:
Description:

Properties:
Name Type Summary
envelopeId string The id of the envelope.
Envelope id
subject string The subject of the
Subject envelope.

601 | P a g e
 DocuSign

GetLoginAccountsResponse
Summary:
Description:

Properties:
Name Type Summary
loginAccounts array of (LoginAccount) Login accounts
Login accounts

602 | P a g e
 DocuSign

ListDocumentsResponse
Summary:
Description:

Properties:
Name Type Summary
envelopeDocuments array of The documents attached
(EnvelopeDocument) to the envelope.
Envelope documents

603 | P a g e
 DocuSign

ListEnvelopesResponse
Summary:
Description:

Properties:
Name Type Summary
folderItems array of (FolderItem) The envelopes within a
Folder items folder.

604 | P a g e
 DocuSign

ListFoldersResponse
Summary:
Description:

Properties:
Name Type Summary
folders array of (Folder) Folders
Folders

605 | P a g e
 DocuSign

ListRecipientsResponse
Summary:
Description:

Properties:
Name Type Summary
signers array of (Signer) Signers
Signers

606 | P a g e
 DocuSign

ListTemplatesResponse
Summary:
Description:

Properties:
Name Type Summary
envelopeTemplates array of The availalbe envelope
(EnvelopeTemplate) templates.
Envelope templates

607 | P a g e
 DocuSign

LoginAccount
Summary:
Description:

Properties:
Name Type Summary
name string The name of the account.
Name
accountIdGuid string The GUID of the account.
Account Id guid

608 | P a g e
 DocuSign

OnEnvelopeStatusChangesResponse
Summary:
Description:

Properties:
Name Type Summary
envelopes array of (Envelope) Envelopes
Envelopes

609 | P a g e
 DocuSign

SendDraftEnvelopeResponse
Summary:
Description:

Properties:
Name Type Summary

610 | P a g e
 DocuSign

SendEnvelopeResponse
Summary:
Description:

Properties:
Name Type Summary
envelopeId string The id of the envelope.
Envelope Id
status string The status of the
Status envelope.
statusDateTime string The datetime the status
Status date time was set.
uri string The URI for the envelope
URI in DocuSign.

611 | P a g e
 DocuSign

Signer
Summary:
Description:

Properties:
Name Type Summary
routingOrder string The signing order of the
Signing Order recipient in the document.
roleName string The role of the signer.
Role
recipientId string The id the recipient.
Recipient Id
name string The name of the recipient.
Name
email string The email of the recipient.
Email

612 | P a g e
 DocuSign

SignerRequest
Summary:
Description:

Properties:
Name Type Summary
routingOrder string The signing order of the
Signing Order recipient in the document.
roleName string The role of the signer.
Role
recipientId string The id the recipient.
Recipient Id
name string The name of the recipient.
Name
email string The email of the recipient.
Email

613 | P a g e
 Easy Redmine

Easy Redmine
Easy Redmine is a web based tool for software project management.

Status: Preview Tier: Premium Version: 1.0.0

Actions:
Name Summary
ListIssues () List issues
CreateIssue Create a task
(CreateIssueRequest issue)
GetIssue (string issue_id) Get task by ID
UpdateIssue (string issue_id, Update a task
UpdateIssueRequest issue)
ListProjects () List projects
CreateProject Create a project
(CreateProjectRequest
project)
GetProject (string project_id) Get project by ID
ListUsers () List users
GetUser (string user_id) Get user by ID
ListPriorities () List priorities

Triggers:
Name Summary
OnNewProject () When a project is created
OnNewIssue (string When a task is created
project_id)

614 | P a g e
 Easy Redmine

OnUpdatedIssue (string When a task is updated

project_id)

Objects:
Name Summary
CreateIssueRequest
CreateProjectRequest
CreateProjectResponse
GetIssueResponse
IssueResponse
ListIssuesResponse
ListPrioritiesResponse
ListProjectsResponse
ListUsersResponse
PriorityResponse
ProjectResponse
UpdateIssueRequest
UserResponse

Actions:
ListIssues
Summary: List issues
Description: List issues

Syntax:
EasyRedmine.ListIssues ()

Returns:

615 | P a g e
 Easy Redmine

Type:ListIssuesResponse

CreateIssue
Summary: Create a task
Description: Create a task

Syntax:
EasyRedmine.CreateIssue (CreateIssueRequest issue)

Parameters:
Name Type Summary Required Related
Action
issue CreateIssueRequest True

Returns:
Type:GetIssueResponse

GetIssue
Summary: Get task by ID
Description: Get task by ID

Syntax:
EasyRedmine.GetIssue (string issue_id)

Parameters:
Name Type Summary Required Related
Action

616 | P a g e
 Easy Redmine

issue_id string Issue True

(Issue)

Returns:
Type:GetIssueResponse

UpdateIssue
Summary: Update a task
Description: Update a task

Syntax:
EasyRedmine.UpdateIssue (string issue_id, UpdateIssueRequest
issue)

Parameters:
Name Type Summary Required Related
Action
issue_id string Issue ID True ListIssues
(Issue ID)
issue UpdateIssueRequest True

Returns:
Type:string

ListProjects
Summary: List projects
Description: List projects

617 | P a g e
 Easy Redmine

Syntax:
EasyRedmine.ListProjects ()

Returns:
Type:ListProjectsResponse

CreateProject
Summary: Create a project
Description: Create a project

Syntax:
EasyRedmine.CreateProject (CreateProjectRequest project)

Parameters:
Name Type Summary Required Related
Action
project CreateProjectRequest True

Returns:
Type:CreateProjectResponse

GetProject
Summary: Get project by ID
Description: Get project by ID

Syntax:
EasyRedmine.GetProject (string project_id)

618 | P a g e
 Easy Redmine

Parameters:
Name Type Summary Required Related
Action
project_id string Project True
(Project)

Returns:
Type:ProjectResponse

ListUsers
Summary: List users
Description: List users

Syntax:
EasyRedmine.ListUsers ()

Returns:
Type:ListUsersResponse

GetUser
Summary: Get user by ID
Description: Get user by ID

Syntax:
EasyRedmine.GetUser (string user_id)

Parameters:

619 | P a g e
 Easy Redmine

Name Type Summary Required Related

Action
user_id string User True
(User)

Returns:
Type:UserResponse

ListPriorities
Summary: List priorities
Description: List priorities

Syntax:
EasyRedmine.ListPriorities ()

Returns:
Type:ListPrioritiesResponse

Triggers:
Trigger OnNewProject
Summary: When a project is created
Description: When a project is created

Syntax:
EasyRedmine.OnNewProject ()

Returns:
Type:ListProjectsResponse

620 | P a g e
 Easy Redmine

Trigger OnNewIssue
Summary: When a task is created
Description: When a task is created

Syntax:
EasyRedmine.OnNewIssue (string project_id)

Parameters:
Name Type Summary Required Related
Action
project_id string Project ID True ListProjects
(Project ID)

Returns:
Type:ListIssuesResponse

Trigger OnUpdatedIssue
Summary: When a task is updated
Description: When a task is updated

Syntax:
EasyRedmine.OnUpdatedIssue (string project_id)

Parameters:
Name Type Summary Required Related
Action
project_id string Project ID True ListProjects
(Project ID)

621 | P a g e
 Easy Redmine

Returns:
Type:ListIssuesResponse

622 | P a g e
 Easy Redmine

CreateIssueRequest
Summary:
Description:

Properties:
Name Type Summary
issue Issue

Issue
Summary:
Description:

Properties:
Name Type Summary
project_id string Project ID
Project ID
priority_id string Priority ID
Priority ID
subject string Subject
Subject
description string Description
Description
start_date string(date-time) yyyy-MM-dd
Start date
due_date string(date-time) yyyy-MM-dd
Due date
estimated_hours number(float) Estimated hours
Estimated hours

623 | P a g e
 Easy Redmine

624 | P a g e
 Easy Redmine

CreateProjectRequest
Summary:
Description:

Properties:
Name Type Summary
project Project

Project
Summary:
Description:

Properties:
Name Type Summary
name string Name of project
Name
identifier string Unique friendly name that
Identifier is different from id
description string Description
Description
homepage string Homepage
Homepage
parent_id string Select the parent project
Parent project ID
is_public boolean Is a public project
Public
inherit_members boolean Inherit members
Inherit members

625 | P a g e
 Easy Redmine

626 | P a g e
 Easy Redmine

CreateProjectResponse
Summary:
Description:

Properties:
Name Type Summary
id integer(int32)
Project id
name string
Project name
identifier string Unique identifier for the
Identifier project
description string
Description
homepage string
Homepage
status integer(int32)
Status
author Author

created_on string(date-time) yyyy-MM-

Created on ddTHH:mm:ss.fffZ
updated_on string(date-time) yyyy-MM-
Updated on ddTHH:mm:ss.fffZ

Author
Summary:
Description:

627 | P a g e
 Easy Redmine

Properties:
Name Type Summary
id integer(int32) Author Id
Author Id
name string Username of author
Author

628 | P a g e
 Easy Redmine

GetIssueResponse
Summary:
Description:

Properties:
Name Type Summary
id integer(int32)
Task Id
project Project

tracker Tracker

status Status

priority Priority

author Author

subject string
Subject
description string
Description
start_date string
Start date
done_ratio integer(int32)
Done ratio
spent_hours number(float)
Spent hours
total_spent_hours number(float)

629 | P a g e
 Easy Redmine

Total spent hours

created_on string(date-time) yyyy-MM-
Created on ddTHH:mm:ss.fffZ
updated_on string(date-time) yyyy-MM-
Updated on ddTHH:mm:ss.fffZ

Project
Summary:
Description:

Properties:
Name Type Summary
id integer(int32)
Project Id
name string
Project name

Tracker
Summary:
Description:

Properties:
Name Type Summary
id integer(int32)
Tracker Id
name string
Tracker

630 | P a g e
 Easy Redmine

Status
Summary:
Description:

Properties:
Name Type Summary
id integer(int32)
Status Id
name string
Status

Priority
Summary:
Description:

Properties:
Name Type Summary
id integer(int32)
Priority Id
name string
Priority

Author
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) User ID of author.

631 | P a g e
 Easy Redmine

Author Id
name string Username of author.
Author

632 | P a g e
 Easy Redmine

IssueResponse
Summary:
Description:

Properties:
Name Type Summary
id integer(int32)
Task Id
project Project

tracker Tracker

status Status

priority Priority

author Author

subject string
Subject
description string
Description
start_date string
Start date
done_ratio integer(int32)
Done ratio
created_on string(date-time) yyyy-MM-
Created on ddTHH:mm:ss.fffZ

633 | P a g e
 Easy Redmine

updated_on string(date-time) yyyy-MM-

Updated on ddTHH:mm:ss.fffZ

Project
Summary:
Description:

Properties:
Name Type Summary
id integer(int32)
Project Id
name string
Project name

Tracker
Summary:
Description:

Properties:
Name Type Summary
id integer(int32)
Tracker Id
name string
Tracker

Status
Summary:
Description:

634 | P a g e
 Easy Redmine

Properties:
Name Type Summary
id integer(int32)
Status Id
name string
Status

Priority
Summary:
Description:

Properties:
Name Type Summary
id integer(int32)
Priority Id
name string
Priority

Author
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) User ID of author
Author Id
name string Username of author
Author

635 | P a g e
 Easy Redmine

636 | P a g e
 Easy Redmine

ListIssuesResponse
Summary:
Description:

Properties:
Name Type Summary
issues array of (IssueResponse) Issues
Issues

637 | P a g e
 Easy Redmine

ListPrioritiesResponse
Summary:
Description:

Properties:
Name Type Summary
issue_priorities array of (PriorityResponse) Priorities
Projects

638 | P a g e
 Easy Redmine

ListProjectsResponse
Summary:
Description:

Properties:
Name Type Summary
projects array of (ProjectResponse) Projects
Projects

639 | P a g e
 Easy Redmine

ListUsersResponse
Summary:
Description:

Properties:
Name Type Summary
users array of (UserResponse) Users
Users

640 | P a g e
 Easy Redmine

PriorityResponse
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Priority Id
Priority Id
name string Name
Name

641 | P a g e
 Easy Redmine

ProjectResponse
Summary:
Description:

Properties:
Name Type Summary
id integer(int32)
Project ID
name string
Project name
identifier string Unique identifier for the
Identifier project.
description string
Description
homepage string
Homepage
status integer(int32)
Status
author Author

created_on string(date-time) yyyy-MM-

Created on ddTHH:mm:ss.fffZ
updated_on string(date-time) yyyy-MM-
Updated on ddTHH:mm:ss.fffZ
start_date string(date-time) yyyy-MM-dd
Start date
due_date string(date-time) yyyy-MM-dd
Due date

642 | P a g e
 Easy Redmine

Author
Summary:
Description:

Properties:
Name Type Summary
id integer(int32)
Author Id
name string
Author

643 | P a g e
 Easy Redmine

UpdateIssueRequest
Summary:
Description:

Properties:
Name Type Summary
issue Issue

Issue
Summary:
Description:

Properties:
Name Type Summary
project_id string Project ID
Project ID
priority_id string Priority ID
Priority ID
subject string Subject
Subject
description string Description
Description
status_id string Status Values: [New,
Status Estimated, Approved,
Realisation, Consultation,
To check, Passive, Done,
Cancelled, Sequence
pending]

644 | P a g e
 Easy Redmine

assigned_to_id string User to be assigned this

Assign to ID task
start_date string(date-time) yyyy-MM-dd
Start date
due_date string(date-time) yyyy-MM-dd
Due date
estimated_hours number(float) Estimated hours
Estimated hours

645 | P a g e
 Easy Redmine

UserResponse
Summary:
Description:

Properties:
Name Type Summary
id integer(int32)
User Id
login string
Login
firstname string
First name
lastname string
Last name
mail string
Email
created_on string(date-time)
Created on
last_login_on string(date-time)
Last login
api_key string
API key
status integer(int32)
Status
easy_user_type Easy_user_type

language string
Language

646 | P a g e
 Easy Redmine

Easy_user_type
Summary:
Description:

Properties:
Name Type Summary
id integer(int32)
User type Id
name string
User type name

647 | P a g e
 Eventbrite

Eventbrite
Eventbrite is a self-service ticketing platform used to create and discover local
events.

Status: Preview Tier: Premium Version: 1.0.0

Actions:
Name Summary
GetOrganizers () Get organizers
GetMyVenues () Get venues
GetMyEvents (string Get My Events
order_by, string status)
GetCategories () Get categories
CreateEvent (string Create event
event.name.html, string
event.description.html, string
event.start.utc, string
event.end.utc, string
event.start.timezone, string
event.end.timezone, string
event.currency,
[advanced][Optional]string
event.organizer_id,
[advanced][Optional]string
event.venue_id,
[advanced][Optional]string
event.category_id,
[advanced][Optional]string

648 | P a g e
 Eventbrite

event.password,
[advanced][Optional]string
event.capacity,
[advanced][Optional]boolean
event.shareable,
[advanced][Optional]boolean
event.invite_only,
[advanced][Optional]boolean
event.online_event,
[advanced][Optional]boolean
event.listed,
[advanced][Optional]boolean
event.hide_start_date,
[advanced][Optional]boolean
event.hide_end_date,
[advanced][Optional]boolean
event.show_remaining)
UpdateEvent (string id, Update event
[Optional]string
event.name.html,
[Optional]string
event.description.html,
[Optional]string
event.start.utc,
[Optional]string
event.end.utc,
[Optional]string
event.start.timezone,
[Optional]string

649 | P a g e
 Eventbrite

event.end.timezone,
[Optional]string
event.currency,
[advanced][Optional]string
event.organizer_id,
[advanced][Optional]string
event.venue_id,
[advanced][Optional]string
event.category_id,
[advanced][Optional]string
event.password,
[advanced][Optional]string
event.capacity,
[advanced][Optional]boolean
event.shareable,
[advanced][Optional]boolean
event.invite_only,
[advanced][Optional]boolean
event.online_event,
[advanced][Optional]boolean
event.listed,
[advanced][Optional]boolean
event.hide_start_date,
[advanced][Optional]boolean
event.hide_end_date,
[advanced][Optional]boolean
event.show_remaining)

650 | P a g e
 Eventbrite

Triggers:
Name Summary
OnNewEvent (string id, When an event is created
[internal]string order_by)
OnOrderChanged (string id) When an order changes

Objects:
Name Summary
CreateEvent_Response
GetCategories_Response
GetMyEvents_Response
GetMyVenues_Response
GetOrganizers_Response
OnNewEventResponseItem
OnOrderChangedResponseItem

Actions:
GetOrganizers
Summary: Get organizers
Description: Get a list of organizers for your account.

Syntax:
Eventbrite.GetOrganizers ()

Returns:
Type:GetOrganizers_Response

651 | P a g e
 Eventbrite

GetMyVenues
Summary: Get venues
Description: Get venues for your account.

Syntax:
Eventbrite.GetMyVenues ()

Returns:
Type:GetMyVenues_Response

GetMyEvents
Summary: Get My Events
Description: Get my Eventbrite events.

Syntax:
Eventbrite.GetMyEvents (string order_by, string status)

Parameters:
Name Type Summary Required Related
Action
order_by string Order of the True
(Order By) returned events.
status string Status of the True
(Status) returned events.

Returns:
Type:GetMyEvents_Response

652 | P a g e
 Eventbrite

GetCategories
Summary: Get categories
Description: Get the Eventbrite event categories.

Syntax:
Eventbrite.GetCategories ()

Returns:
Type:GetCategories_Response

CreateEvent
Summary: Create event
Description: Create a new Eventbrite event.

Syntax:
Eventbrite.CreateEvent (string event.name.html, string
event.description.html, string event.start.utc, string
event.end.utc, string event.start.timezone, string
event.end.timezone, string event.currency,
[advanced][Optional]string event.organizer_id,
[advanced][Optional]string event.venue_id,
[advanced][Optional]string event.category_id,
[advanced][Optional]string event.password,
[advanced][Optional]string event.capacity,
[advanced][Optional]boolean event.shareable,
[advanced][Optional]boolean event.invite_only,
[advanced][Optional]boolean event.online_event,
[advanced][Optional]boolean event.listed,
[advanced][Optional]boolean event.hide_start_date,
[advanced][Optional]boolean event.hide_end_date,
[advanced][Optional]boolean event.show_remaining)

653 | P a g e
 Eventbrite

Parameters:
Name Type Summary Requir Related
ed Action
event.name.html string The name of True
(Name) the event.
event.description string The True
.html (Description) description
on the
event page.
event.start.utc string Start time True
(Start) (UTC format
Ex. "2017-
01-
12T13:45:30
Z").
event.end.utc string End time True
(End) (UTC format
Ex. 2017-01-
12T16:45:30
Z).
event.start.timez string Timezone of True
one (Start timezone)Values: the event.
[Pacific/Midway,
Pacific/Honolulu,
America/Anchorage,
America/Los_Angeles,
America/Denver,
America/Chicago,
America/New_York,

654 | P a g e
 Eventbrite

America/Santiago,
America/Halifax,
America/Curacao,
America/St_Johns,
America/Sao_Paulo,
America/Argentina/Bueno
s_Aires,
America/Noronha,
Atlantic/Azores,
Europe/London,
Africa/Casablanca,
Europe/Paris,
Europe/Copenhagen,
Europe/Madrid,
Europe/Rome,
Africa/Cairo,
Africa/Johannesburg,
Europe/Athens,
Africa/Nairobi,
Europe/Istanbul,
Europe/Moscow,
Asia/Tehran, Asia/Dubai,
Asia/Ashgabat,
Asia/Kolkata,
Asia/Kathmandu,
Asia/Almaty,
Asia/Bangkok,
Asia/Jakarta,
Asia/Hong_Kong,

655 | P a g e
 Eventbrite

Asia/Shanghai,
Australia/Perth,
Asia/Pyongyang,
Asia/Seoul, Asia/Tokyo,
Australia/Darwin,
Australia/Sydney,
Asia/Magadan,
Pacific/Auckland]
event.end.timezo string Timezone of True
ne (End timezone)Values: the event.
[Pacific/Midway,
Pacific/Honolulu,
America/Anchorage,
America/Los_Angeles,
America/Denver,
America/Chicago,
America/New_York,
America/Santiago,
America/Halifax,
America/Curacao,
America/St_Johns,
America/Sao_Paulo,
America/Argentina/Bueno
s_Aires,
America/Noronha,
Atlantic/Azores,
Europe/London,
Africa/Casablanca,
Europe/Paris,

656 | P a g e
 Eventbrite

Europe/Copenhagen,
Europe/Madrid,
Europe/Rome,
Africa/Cairo,
Africa/Johannesburg,
Europe/Athens,
Africa/Nairobi,
Europe/Istanbul,
Europe/Moscow,
Asia/Tehran, Asia/Dubai,
Asia/Ashgabat,
Asia/Kolkata,
Asia/Kathmandu,
Asia/Almaty,
Asia/Bangkok,
Asia/Jakarta,
Asia/Hong_Kong,
Asia/Shanghai,
Australia/Perth,
Asia/Pyongyang,
Asia/Seoul, Asia/Tokyo,
Australia/Darwin,
Australia/Sydney,
Asia/Magadan,
Pacific/Auckland]
event.currency string Currency for True
(Event currency)Values: this Event's
[USD, AUD, CAD, CHF, transactions
DKK, EUR, GBP, HKD, IDR, .

657 | P a g e
 Eventbrite

INR, JPY, KRW, MXN, MYR,

NOK, NZD, RUB, SAR, SEK,
TRY, TWD, ZAR]
event.organizer_i string The ID of False GetOrgani
d (Organizer) the zers
organizer of
this event.
event.venue_id string A False GetMyVen
(Venue) previously- ues
created
venue to
associate
with this
event.
event.category_i string The False GetCatego
d (Category) category of ries
the event.
event.password string Password False
(Password) needed to
see the
event in
unlisted
mode.
event.capacity string Set specific False
(Capacity) capacity (if
omitted,
sums ticket
capacities).

658 | P a g e
 Eventbrite

event.shareable boolean If users can False

(Shareable) share the
event on
social
media.
event.invite_only boolean Only invited False
(Invite Only) users can
see the
event page.
event.online_eve boolean Whether False
nt (Online Event) the event is
online-only
(no venue).
event.listed boolean If the event False
(Listed) is publicly
listed and
searchable.
event.hide_start_ boolean Whether False
date (Hide start date) the start
date should
be hidden.
event.hide_end_ boolean Whether False
date (Hide end date) the end
date should
be hidden.
event.show_rem boolean If the False
aining (Show Remaining) remaining
number of
tickets is

659 | P a g e
 Eventbrite

publicly
visible on
the event
page.

Returns:
Type:CreateEvent_Response

UpdateEvent
Summary: Update event
Description: Update an existing event.

Syntax:
Eventbrite.UpdateEvent (string id, [Optional]string
event.name.html, [Optional]string event.description.html,
[Optional]string event.start.utc, [Optional]string
event.end.utc, [Optional]string event.start.timezone,
[Optional]string event.end.timezone, [Optional]string
event.currency, [advanced][Optional]string event.organizer_id,
[advanced][Optional]string event.venue_id,
[advanced][Optional]string event.category_id,
[advanced][Optional]string event.password,
[advanced][Optional]string event.capacity,
[advanced][Optional]boolean event.shareable,
[advanced][Optional]boolean event.invite_only,
[advanced][Optional]boolean event.online_event,
[advanced][Optional]boolean event.listed,
[advanced][Optional]boolean event.hide_start_date,
[advanced][Optional]boolean event.hide_end_date,
[advanced][Optional]boolean event.show_remaining)

Parameters:

660 | P a g e
 Eventbrite

Name Type Summary Requir Related

ed Action
id string Event to True GetMyEve
(Event) update. nts
event.name.html string The name of False
(Name) the event.
event.description string The False
.html (Description) description
on the
event page.
event.start.utc string Start time False
(Start) (UTC format
Ex. "2017-
01-
12T13:45:30
Z").
event.end.utc string End time False
(End) (UTC format
Ex. 2017-01-
12T16:45:30
Z).
event.start.timez string Timezone of False
one (Start timezone)Values: the event.
[Pacific/Midway,
Pacific/Honolulu,
America/Anchorage,
America/Los_Angeles,
America/Denver,
America/Chicago,

661 | P a g e
 Eventbrite

America/New_York,
America/Santiago,
America/Halifax,
America/Curacao,
America/St_Johns,
America/Sao_Paulo,
America/Argentina/Bueno
s_Aires,
America/Noronha,
Atlantic/Azores,
Europe/London,
Africa/Casablanca,
Europe/Paris,
Europe/Copenhagen,
Europe/Madrid,
Europe/Rome,
Africa/Cairo,
Africa/Johannesburg,
Europe/Athens,
Africa/Nairobi,
Europe/Istanbul,
Europe/Moscow,
Asia/Tehran, Asia/Dubai,
Asia/Ashgabat,
Asia/Kolkata,
Asia/Kathmandu,
Asia/Almaty,
Asia/Bangkok,
Asia/Jakarta,

662 | P a g e
 Eventbrite

Asia/Hong_Kong,
Asia/Shanghai,
Australia/Perth,
Asia/Pyongyang,
Asia/Seoul, Asia/Tokyo,
Australia/Darwin,
Australia/Sydney,
Asia/Magadan,
Pacific/Auckland]
event.end.timezo string Timezone of False
ne (End timezone)Values: the event.
[Pacific/Midway,
Pacific/Honolulu,
America/Anchorage,
America/Los_Angeles,
America/Denver,
America/Chicago,
America/New_York,
America/Santiago,
America/Halifax,
America/Curacao,
America/St_Johns,
America/Sao_Paulo,
America/Argentina/Bueno
s_Aires,
America/Noronha,
Atlantic/Azores,
Europe/London,
Africa/Casablanca,

663 | P a g e
 Eventbrite

Europe/Paris,
Europe/Copenhagen,
Europe/Madrid,
Europe/Rome,
Africa/Cairo,
Africa/Johannesburg,
Europe/Athens,
Africa/Nairobi,
Europe/Istanbul,
Europe/Moscow,
Asia/Tehran, Asia/Dubai,
Asia/Ashgabat,
Asia/Kolkata,
Asia/Kathmandu,
Asia/Almaty,
Asia/Bangkok,
Asia/Jakarta,
Asia/Hong_Kong,
Asia/Shanghai,
Australia/Perth,
Asia/Pyongyang,
Asia/Seoul, Asia/Tokyo,
Australia/Darwin,
Australia/Sydney,
Asia/Magadan,
Pacific/Auckland]
event.currency string Currency for False
(Event currency)Values: this Event's
[USD, AUD, CAD, CHF,

664 | P a g e
 Eventbrite

DKK, EUR, GBP, HKD, IDR, transactions

INR, JPY, KRW, MXN, MYR, .
NOK, NZD, RUB, SAR, SEK,
TRY, TWD, ZAR]
event.organizer_i string The ID of False GetOrgani
d (Organizer) the zers
organizer of
this event.
event.venue_id string A False GetMyVen
(Venue) previously- ues
created
venue to
associate
with this
event.
event.category_i string The False GetCatego
d (Category) category of ries
the event.
event.password string Password False
(Password) needed to
see the
event in
unlisted
mode.
event.capacity string Set specific False
(Capacity) capacity (if
omitted,
sums ticket
capacities).

665 | P a g e
 Eventbrite

event.shareable boolean Set specific False

(Shareable) capacity (if
omitted,
sums ticket
capacities).
event.invite_only boolean Only invited False
(Invite Only) users can
see the
event page.
event.online_eve boolean Whether False
nt (Online Event) the event is
online-only
(no venue).
event.listed boolean If the event False
(Listed) is publicly
listed and
searchable.
event.hide_start_ boolean Whether False
date (Hide start date) the start
date should
be hidden.
event.hide_end_ boolean Whether False
date (Hide end date) the start
date should
be hidden.
event.show_rem boolean If the False
aining (Show Remaining) remaining
number of
tickets is

666 | P a g e
 Eventbrite

publicly
visible on
the event
page.

Returns:
Type:CreateEvent_Response

Triggers:
Trigger OnNewEvent
Summary: When an event is created
Description: Triggers a flow when an organizer has a new event.

Syntax:
Eventbrite.OnNewEvent (string id, [internal]string order_by)

Parameters:
Name Type Summary Required Related
Action
id string Organizer to True GetOrganizers
(Organizer) trigger on new
events.
order_by string The order True
(Order By) events should
be returned in

Returns:
Type:array of (OnNewEventResponseItem)

667 | P a g e
 Eventbrite

Trigger OnOrderChanged
Summary: When an order changes
Description: Trigger a flow when an order changes.

Syntax:
Eventbrite.OnOrderChanged (string id)

Parameters:
Name Type Summary Required Related
Action
id string Event to trigger True GetMyEvents
(Event) on changed
order.

Returns:
Type:array of (OnOrderChangedResponseItem)

668 | P a g e
 Eventbrite

CreateEvent_Response
Summary:
Description:

Properties:
Name Type Summary
name Name

description Description

id string The id of the event.

Id
url string The URL of the event.
URL
start Start
Start
end End
End
created string(date-time) The date-time the event
Created Date-Time was created at.
changed string(date-time) The date-time the event
Chaged Date-Time was changed at.
capacity integer(int32) The capacity of the event.
Capacity
online_event boolean A boolean indicating
Is Online Event whether or not the event
is online.
organizer_id string The id of the organizer of
Organizer Id the event.

669 | P a g e
 Eventbrite

venue_id string The id of the venue of the

Venue Id event.
category_id string The id of the category of
Category Id the event.

Name
Summary:
Description:

Properties:
Name Type Summary
text string The name of the event (in
Name text form).

Description
Summary:
Description:

Properties:
Name Type Summary
text string The description of the
Description event.

Start
Summary: Start
Description:

Properties:

670 | P a g e
 Eventbrite

Name Type Summary

timezone string The timezone of the start
Timezone of the event.
local string(date-time) The start date-time of the
local event in local time.
utc string(date-time) The start date-time of the
UTC event in UTC.

End
Summary: End
Description:

Properties:
Name Type Summary
timezone string The timezone of the end
Timezone of the event.
local string(date-time) The end date-time of the
local event in local time.
utc string(date-time) The end date-time of the
UTC event in UTC.

671 | P a g e
 Eventbrite

GetCategories_Response
Summary:
Description:

Properties:
Name Type Summary
categories array of (CategoriesItem)

CategoriesItem
Summary:
Description:

Properties:
Name Type Summary
id string The id of the category.
Id
name string The name of the category.
Name

672 | P a g e
 Eventbrite

GetMyEvents_Response
Summary:
Description:

Properties:
Name Type Summary
events array of (EventsItem)

EventsItem
Summary:
Description:

Properties:
Name Type Summary
name Name

id string The id of the event.

Id

Name
Summary:
Description:

Properties:
Name Type Summary
text string The name of the event (in
Name text form).

673 | P a g e
 Eventbrite

674 | P a g e
 Eventbrite

GetMyVenues_Response
Summary:
Description:

Properties:
Name Type Summary
venues array of (VenuesItem)
Venue

VenuesItem
Summary:
Description:

Properties:
Name Type Summary
id string The id of the venue.
Id
name string The name of the venue.
Name

675 | P a g e
 Eventbrite

GetOrganizers_Response
Summary:
Description:

Properties:
Name Type Summary
organizers array of (OrganizersItem)
Organizer

OrganizersItem
Summary:
Description:

Properties:
Name Type Summary
id string The id of the organizer.
Id
name string The name of the organizer.
Name

676 | P a g e
 Eventbrite

OnNewEventResponseItem
Summary:
Description:

Properties:
Name Type Summary
name Name

description Description

id string The id of the event.

Id
url string The URL of the event.
URL
start Start
Start
end End
End
created string(date-time) The date-time the event
Created Date-Time was created at.
changed string(date-time) The date-time the event
Chaged Date-Time was changed at.
capacity integer(int32) The capacity of the event.
Capacity
online_event boolean A boolean indicating
Is Online Event whether or not the event
is online.
organizer_id string The id of the organizer of
Organizer Id the event.

677 | P a g e
 Eventbrite

venue_id string The id of the venue of the

Venue Id event.
category_id string The id of the category of
Category Id the event.

Name
Summary:
Description:

Properties:
Name Type Summary
text string The name of the event (in
Name text form).

Description
Summary:
Description:

Properties:
Name Type Summary
text string The description of the
Description event (in text form).

Start
Summary: Start
Description:

Properties:

678 | P a g e
 Eventbrite

Name Type Summary

timezone string The timezone of the start
Timezone of the event.
local string(date-time) The start date-time of the
local event in local time.
utc string(date-time) The start date-time of the
UTC event in UTC.

End
Summary: End
Description:

Properties:
Name Type Summary
timezone string The timezone of the end
Timezone of the event.
local string(date-time) The end date-time of the
local event in local time.
utc string(date-time) The end date-time of the
UTC event in UTC.

679 | P a g e
 Eventbrite

OnOrderChangedResponseItem
Summary:
Description:

Properties:
Name Type Summary
id string The id of the order.
Id
name string The name of the order.
Name
first_name string The first name on the
First Name order.
last_name string The last name on the
Last Name order.
email string The email on the order.
Email
status string The status of the order.
Status

680 | P a g e
 Face API

Face API
Azure Cognitive Services Face API allows you to detect, identify, analyze,
organize and tag faces in photos.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
GetFaceListInternal ()
GetPersonGroupsInternal ()
GetFaceList ([none]string Get a face list
faceListId)
CreateFaceList (string faceListId, Create a face list
CreateFaceListParameterBody
body)
Detect ([internal][Optional]string Detect faces
returnFaceId,
DetectParameterBody body,
[internal][Optional]string
returnFaceAttributes,
[internal][Optional]string
returnFaceLandmarks)
AddPersonFace (string Add a person face
personGroupId, string personId,
AddPersonFaceParameterBody
body, [advanced][Optional]string
targetFace,

681 | P a g e
 Face API

[advanced][Optional]string
userData)
AddFaceToFaceList Add face to face list
(AddFaceToFaceListParameterBody
body, [advanced][Optional]string
targetFace,
[advanced][Optional]string
userData, [none]string faceListId)
GetPersonGroup (string Get a person group
personGroupId)
CreatePersonGroup (string Create a person group
personGroupId,
CreatePersonGroupParameterBody
body)
Verify (VerifyParameterBody body) Find person from face
GetPersonFace (string Get a person face
personGroupId, string personId,
string persistedFaceId)
GetPersonsInternal (string
personGroupId)
CreatePerson (string Create a person
personGroupId,
CreatePersonParameterBody body)
GetPerson (string personGroupId, Get a person
string personId)

Triggers:
Name Summary

682 | P a g e
 Face API

Objects:
Name Summary
AddFaceToFaceListParameterBody
AddPersonFaceParameterBody
AddPersonFaceResponse
CreateFaceListParameterBody
CreatePersonGroupParameterBody
CreatePersonParameterBody
CreatePersonResponse
DetectParameterBody
DetectResponseItem
GetFaceListInternalResponseItem
GetFaceListResponse
GetPersonFaceResponse
GetPersonGroupResponse
GetPersonGroupsInternalResponseItem
GetPersonResponse
GetPersonsInternalResponseItem
VerifyParameterBody
VerifyResponse

Actions:
GetFaceListInternal
Summary:
Description:

Syntax:
FaceAPI.GetFaceListInternal ()

683 | P a g e
 Face API

Returns:
Type:array of (GetFaceListInternalResponseItem)

GetPersonGroupsInternal
Summary:
Description:

Syntax:
FaceAPI.GetPersonGroupsInternal ()

Returns:
Type:array of (GetPersonGroupsInternalResponseItem)

GetFaceList
Summary: Get a face list
Description: Retrieve a face list's information, including faceListId, name, userData and
faces in the face list.

Syntax:
FaceAPI.GetFaceList ([none]string faceListId)

Parameters:
Name Type Summary Required Related Action
faceListId string faceListId of True GetFaceListInternal
(Face List the target face
Id) list.

Returns:

684 | P a g e
 Face API

Type:GetFaceListResponse

CreateFaceList
Summary: Create a face list
Description: Create an empty face list with user-specified faceListId, name and an
optional userData.

Syntax:
FaceAPI.CreateFaceList (string faceListId,
CreateFaceListParameterBody body)

Parameters:
Name Type Summary Required Related
Action
faceListId string Valid True
(Face List Id) character is
letter in
lower case
or digit or '-'
or '_',
maximum
length is 64
body CreateFaceListParameterBody True

Returns:

Detect
Summary: Detect faces

685 | P a g e
 Face API

Description: Detect human faces in an image and returns face locations, and optionally
with faceIds, landmarks, and attributes.

Syntax:
FaceAPI.Detect ([internal][Optional]string returnFaceId,
DetectParameterBody body, [internal][Optional]string
returnFaceAttributes, [internal][Optional]string
returnFaceLandmarks)

Parameters:
Name Type Summary Required Related
Action
returnFaceId string False
(returnFaceIds)
body DetectParameterBody True

returnFaceAttributes string False

returnFaceLandmarks string False

Returns:
Type:array of (DetectResponseItem)

AddPersonFace
Summary: Add a person face
Description: Add a representative face to a person for identification.

Syntax:

686 | P a g e
 Face API

FaceAPI.AddPersonFace (string personGroupId, string personId,

AddPersonFaceParameterBody body, [advanced][Optional]string
targetFace, [advanced][Optional]string userData)

Parameters:
Name Type Summary Requi Related Action
red
personGr string Person group True GetPersonGroup
oupId (Person Group Id) sInternal
personId string Target person that True GetPersonsInter
(Person Id) the face is added to. nal
body AddPersonFacePara True
meterBody

targetFac string A face rectangle to False

e (Target Face) specify the target
face to be added to a
person, in the format
of
targetFace=left,top,w
idth,height
userData string User-specified data False
(User Data) about the target face
to add for any
purpose. The
maximum length is
1KB.

Returns:
Type:AddPersonFaceResponse
687 | P a g e
 Face API

AddFaceToFaceList
Summary: Add face to face list
Description: Add face to face list.

Syntax:
FaceAPI.AddFaceToFaceList (AddFaceToFaceListParameterBody body,
[advanced][Optional]string targetFace,
[advanced][Optional]string userData, [none]string faceListId)

Parameters:
Name Type Summary Requi Related
red Action
body AddFaceToFaceListPara True
meterBody

targetF string A face rectangle to False

ace (Target Face) specify the target face
to be added to a
person, in the format
of
targetFace=left,top,wi
dth,height
userDa string User-specified data False
ta (User Data) about the target face
to add for any
purpose. The
maximum length is
1KB.

688 | P a g e
 Face API

faceList string Valid character is letter True GetFaceListIn

Id (Face List Id) in lower case or digit ternal
or '-' or '_', maximum
length is 64.

Returns:
Type:AddPersonFaceResponse

GetPersonGroup
Summary: Get a person group
Description: Retrieve the information of a person group, including its name and
userData.

Syntax:
FaceAPI.GetPersonGroup (string personGroupId)

Parameters:
Name Type Summary Required Related Action
personGroupId string Target True GetPersonGroupsInternal
(Person Person
Group Group Id.
Id)

Returns:
Type:GetPersonGroupResponse

CreatePersonGroup
Summary: Create a person group

689 | P a g e
 Face API

Description: Create a new person group with specified personGroupId, name and user-
provided userData.

Syntax:
FaceAPI.CreatePersonGroup (string personGroupId,
CreatePersonGroupParameterBody body)

Parameters:
Name Type Summary Require Relate
d d
Action
personGroupI string New True
d (Person Group Id) Person
Group Id
(valid
character
s include
numbers,
English
letters in
lower
case, '-'
and '_')
body CreatePersonGroupParameterBod True
y

Returns:

690 | P a g e
 Face API

Verify
Summary: Find person from face
Description: Verify whether two faces belong to a same person or whether one face
belongs to a person.

Syntax:
FaceAPI.Verify (VerifyParameterBody body)

Parameters:
Name Type Summary Required Related
Action
body VerifyParameterBody True

Returns:
Type:VerifyResponse

GetPersonFace
Summary: Get a person face
Description: Retrieve information about a persisted face specified by persistedFaceId,
personId and its belonging personGroupId.

Syntax:
FaceAPI.GetPersonFace (string personGroupId, string personId,
string persistedFaceId)

Parameters:
Name Type Summary Require Related Action
d

691 | P a g e
 Face API

personGroupId string Specifying the True GetPersonGroupsInterna

(Person person group l
Group Id) containing the
target person.
personId string Specifying the True GetPersonsInternal
(Person target person
Id) that the face
belongs to.
persistedFaceI string The True GetPerson
d (Persiste persistedFaceI
d Face Id) d of the target
persisted face
of the person.

Returns:
Type:GetPersonFaceResponse

GetPersonsInternal
Summary:
Description:

Syntax:
FaceAPI.GetPersonsInternal (string personGroupId)

Parameters:
Name Type Summary Required Related
Action
personGroupId string True
(personGroupId)

692 | P a g e
 Face API

Returns:
Type:array of (GetPersonsInternalResponseItem)

CreatePerson
Summary: Create a person
Description: Create a new person in a specified person group.

Syntax:
FaceAPI.CreatePerson (string personGroupId,
CreatePersonParameterBody body)

Parameters:
Name Type Summar Requir Related Action
y ed
personGrou string Specifyi True GetPersonGroupsInte
pId (Person Group Id) ng the rnal
target
person
group to
create
the
person.
body CreatePersonParameter True
Body

Returns:
Type:CreatePersonResponse

693 | P a g e
 Face API

GetPerson
Summary: Get a person
Description: Retrieve a person's information, including registered persisted faces,
name and userData.

Syntax:
FaceAPI.GetPerson (string personGroupId, string personId)

Parameters:
Name Type Summary Required Related Action
personGroupId string Specifying True GetPersonGroupsInternal
(Person the person
Group group
Id) containing
the target
person.
personId string Specifying True GetPersonsInternal
(Person the target
Id) person.

Returns:
Type:GetPersonResponse

694 | P a g e
 Face API

AddFaceToFaceListParameterBody
Summary:
Description:

Properties:
Name Type Summary
url string Image must be JPEG, PNG,
Image Url GIF(the first frame), or
BMP

695 | P a g e
 Face API

AddPersonFaceParameterBody
Summary:
Description:

Properties:
Name Type Summary
url string Image must be JPEG, PNG,
Image Url GIF(the first frame), or
BMP

696 | P a g e
 Face API

AddPersonFaceResponse
Summary:
Description:

Properties:
Name Type Summary
persistedFaceId string
Persisted Face Id

697 | P a g e
 Face API

CreateFaceListParameterBody
Summary:
Description:

Properties:
Name Type Summary
name string Name of the created face
Face List Name list, maximum length is
128.
userData string Optional user defined data
User Data for the face list. Length
should not exceed 16KB.

698 | P a g e
 Face API

CreatePersonGroupParameterBody
Summary:
Description:

Properties:
Name Type Summary
name string Person group display
Name name. The maximum
length is 128.
userData string User-provided data
User Data attached to the person
group. The size limit is
16KB.

699 | P a g e
 Face API

CreatePersonParameterBody
Summary:
Description:

Properties:
Name Type Summary
name string Display name of the target
Name person. The maximum
length is 128.
userData string Optional fields for user-
User Data provided data attached to
a person. Size limit is
16KB.

700 | P a g e
 Face API

CreatePersonResponse
Summary:
Description:

Properties:
Name Type Summary
personId string
Person Id

701 | P a g e
 Face API

DetectParameterBody
Summary:
Description:

Properties:
Name Type Summary
url string Image must be JPEG, PNG,
Image Url GIF(the first frame), or
BMP

702 | P a g e
 Face API

DetectResponseItem
Summary:
Description:

Properties:
Name Type Summary
faceId string Unique faceId of the
Face Id detected face. Will expire
24 hours after detection
call.
faceRectangle FaceRectangle
Face Rectangle
faceLandmarks FaceLandmarks
Face Landmarks
faceAttributes FaceAttributes

FaceRectangle
Summary: Face Rectangle
Description:

Properties:
Name Type Summary
top integer(int32) Parameters of a rectangle
Top area for the face location
on image.
left integer(int32) Parameters of a rectangle
Left area for the face location
on image.

703 | P a g e
 Face API

width integer(int32) Parameters of a rectangle

Width area for the face location
on image.
height integer(int32) Parameters of a rectangle
Height area for the face location
on image.

FaceLandmarks
Summary: Face Landmarks
Description:

Properties:
Name Type Summary
pupilLeft PupilLeft

pupilRight PupilRight

noseTip NoseTip

mouthLeft MouthLeft

mouthRight MouthRight

eyebrowLeftOuter EyebrowLeftOuter

eyebrowLeftInner EyebrowLeftInner

eyeLeftOuter EyeLeftOuter

704 | P a g e
 Face API

eyeLeftTop EyeLeftTop

eyeLeftBottom EyeLeftBottom

eyeLeftInner EyeLeftInner

eyebrowRightInner EyebrowRightInner

eyebrowRightOuter EyebrowRightOuter

eyeRightInner EyeRightInner

eyeRightTop EyeRightTop

eyeRightBottom EyeRightBottom

eyeRightOuter EyeRightOuter

noseRootLeft NoseRootLeft

noseRootRight NoseRootRight

noseLeftAlarTop NoseLeftAlarTop

noseRightAlarTop NoseRightAlarTop

noseLeftAlarOutTip NoseLeftAlarOutTip

noseRightAlarOutTip NoseRightAlarOutTip

705 | P a g e
 Face API

upperLipTop UpperLipTop

upperLipBottom UpperLipBottom

underLipTop UnderLipTop

underLipBottom UnderLipBottom

PupilLeft
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate of the
Left Pupil X left pupil.
y number(float) The y-coordinate of the
Left Pupil Y left pupil.

PupilRight
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate of the
Right Pupil X right pupil.

706 | P a g e
 Face API

y number(float) The y-coordinate of the

Right Pupil Y right pupil.

NoseTip
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate of the
Nose Tip X nose tip.
y number(float) The y-coordinate of the
Nose Tip Y nose tip.

MouthLeft
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for the
Mouth Left X left side of the mouth.
y number(float) The y-coordinate for the
Mouth Left Y left side of the mouth.

MouthRight
Summary:
Description:

707 | P a g e
 Face API

Properties:
Name Type Summary
x number(float) The x-coordinate for the
Mouth Right X right side of the mouth.
y number(float) The y-coordinate for the
Mouth Right Y right side of the mouth.

EyebrowLeftOuter
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for the
Outer Left Eyebrow X outer side of the left
eyebrow.
y number(float) The y-coordinate for the
Outer Left Eyebrow Y outer side of the left
eyebrow.

EyebrowLeftInner
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for the
Inner Left Eybrow X inner side of the left
eyebrow.

708 | P a g e
 Face API

y number(float) The y-coordinate for the

Inner Left Eyebrow Y inner side of the left
eyebrow.

EyeLeftOuter
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for the
Outer Left Eye X outer side of the left eye.
y number(float) The y-coordinate for the
Outer Left Eye Y outer side of the left eye.

EyeLeftTop
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for the
Top of Left Eye X top of the left eye.
y number(float) The y-coordinate for the
Top of Left Eye Y top of the left eye.

EyeLeftBottom
Summary:
Description:

709 | P a g e
 Face API

Properties:
Name Type Summary
x number(float) The x-coordinate for the
Bottom of Left Eye X bottom of the left eye.
y number(float) The y-coordinate for the
Bottom of Left Eye Y bottom of the left eye.

EyeLeftInner
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for the
Inner Left Eye X inner side of the left eye.
y number(float) The y-coordinate for the
Inner Left Eye Y inner side of the left eye.

EyebrowRightInner
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for the
Inner Right Eybrow X inner side of the right
eyebrow.

710 | P a g e
 Face API

y number(float) The y-coordinate for the

Inner Right Eyebrow Y inner side of the right
eyebrow.

EyebrowRightOuter
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for the
Outer Right Eyebrow X outer side of the right
eyebrow.
y number(float) The y-coordinate for the
Outer Right Eyebrow Y outer side of the right
eyebrow.

EyeRightInner
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for the
Inner Right Eye X inner side of the right eye.
y number(float) The y-coordinate for the
Inner Right Eye Y inner side of the right eye.

711 | P a g e
 Face API

EyeRightTop
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for the
Top of Right Eye X top of the right eye.
y number(float) The y-coordinate for the
Top of Right Eye Y top of the right eye.

EyeRightBottom
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for the
Bottom of Right Eye X bottom of the right eye.
y number(float) The y-coordinate for the
Bottom of Right Eye Y bottom of the right eye.

EyeRightOuter
Summary:
Description:

Properties:
Name Type Summary

712 | P a g e
 Face API

x number(float) The x-coordinate for the

Outer Right Eye X outer side of the right eye.
y number(float) The y-coordinate for the
Outer Right Eye Y outer side of the right eye.

NoseRootLeft
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for left
Left Nose Root X side of the nose root.
y number(float) The y-coordinate for left
Left Nose Root Y side of the nose root.

NoseRootRight
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for right
Right Nose Root X side of the nose root.
y number(float) The y-coordinate for right
Right Nose Root Y side of the nose root.

NoseLeftAlarTop
Summary:

713 | P a g e
 Face API

Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for top
Top of Left Nose Altar X of the left nose altar.
y number(float) The y-coordinate for top
Top of Left Nose Altar Y of the left nose altar.

NoseRightAlarTop
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for top
Top of Right Nose Altar X of the right nose altar.
y number(float) The y-coordinate for top
Top of Right Nose Altar Y of the right nose altar.

NoseLeftAlarOutTip
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for tip of
Tip of Left Nose Altar Out X the left nose altar.

714 | P a g e
 Face API

y number(float) The y-coordinate for tip of

Tip of Left Nose Altar Out Y the left nose altar/

NoseRightAlarOutTip
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for tip of
Tip of Right Nose Altar Out the right nose altar.
X
y number(float) The y-coordinate for tip of
Tip of Right Nose Altar Out the right nose altar.
Y

UpperLipTop
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for top
Top of Upper Lip X of upper lip.
y number(float) The y-coordinate for top
Top of Upper Lip Y of upper lip.

UpperLipBottom
Summary:

715 | P a g e
 Face API

Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for
Bottom of Upper Lip X bottom of upper lip.
y number(float) The y-coordinate for
Bottom of Upper Lip Y bottom of upper lip.

UnderLipTop
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for top
Top of Under Lip X of under lip.
y number(float) The y-coordinate for top
Top of Under Lip Y of under lip.

UnderLipBottom
Summary:
Description:

Properties:
Name Type Summary
x number(float) The x-coordinate for
Bottom of Under Lip X bottom of under lip.

716 | P a g e
 Face API

y number(float) The y-coordinate for

Bottom of Under Lip Y bottom of under lip.

FaceAttributes
Summary:
Description:

Properties:
Name Type Summary
smile number(float) Intensity between [0,1].
Smile
headPose HeadPose

gender string Male for female.

Gender
age number(float) Age of person.
Age
facialHair FacialHair

glasses string Type of glasses.

Glasses

HeadPose
Summary:
Description:

Properties:
Name Type Summary

717 | P a g e
 Face API

pitch number(float) Reserved field, always

Head Pose Pitch returns 0.
roll number(float) Roll of the head pose.
Head Pose Roll
yaw number(float) Yaw of the head pose.
Head Pose Yaw

FacialHair
Summary:
Description:

Properties:
Name Type Summary
moustache number(float) Intensity between [0,1].
Moustache
beard number(float) Intensity between [0,1].
Beard
sideburns number(float) Intensity between [0,1].
Sideburns

718 | P a g e
 Face API

GetFaceListInternalResponseItem
Summary:
Description:

Properties:
Name Type Summary
faceListId string
Face List Id
name string
Name
userData string
User Data

719 | P a g e
 Face API

GetFaceListResponse
Summary:
Description:

Properties:
Name Type Summary
persistedFaces array of
(PersistedFacesItem)
Persisted Faces
faceListId string faceListId of the target
Face List Id face list.
name string Face list's display name.
Name
userData string User-provided data
User Data attached to the face list.

PersistedFacesItem
Summary:
Description:

Properties:
Name Type Summary
persistedFaceId string Id of the face.
Persisted Face Id
userData string User-provided data
User Data attached to each face.

720 | P a g e
 Face API

GetPersonFaceResponse
Summary:
Description:

Properties:
Name Type Summary
persistedFaceId string
Persisted Face Id
userData string

721 | P a g e
 Face API

GetPersonGroupResponse
Summary:
Description:

Properties:
Name Type Summary
personGroupId string
Person Group Id
name string
Name
userData string

722 | P a g e
 Face API

GetPersonGroupsInternalResponseItem
Summary:
Description:

Properties:
Name Type Summary
personGroupId string

name string

userData string

723 | P a g e
 Face API

GetPersonResponse
Summary:
Description:

Properties:
Name Type Summary
personId string
Person Id
persistedFaceIds array of (string)
Persisted Face Ids
name string
Name
userData string
User Data

724 | P a g e
 Face API

GetPersonsInternalResponseItem
Summary:
Description:

Properties:
Name Type Summary
personId string

persistedFaceIds array of (string)

name string

userData string

725 | P a g e
 Face API

VerifyParameterBody
Summary:
Description:

Properties:
Name Type Summary
faceId string Unique faceId of the
Face Id detected face. Will expire
24 hours after detection
call.
personGroupId string Person Group Id created
Person Group Id in Face API - Create
Person Group action.
personId string Person Id created in Face
Person Id API - Create Person action.

726 | P a g e
 Face API

VerifyResponse
Summary:
Description:

Properties:
Name Type Summary
isIdentical boolean True if the two faces
Is Identical belong to the same
person or the face
belongs to the person,
otherwise false.
confidence number(float) A number indicates the
Confidence similarity confidence of
whether two faces belong
to the same person, or
whether the face belongs
to the person.

727 | P a g e
 Facebook

Facebook
Facebook API allows you to access and publish posts on your Facebook user
account

Status: Production Tier: Standard Version: 1.0

Actions:
Name Summary
MyTimeline ([Optional]string Get feed from my timeline
fields,
[advanced][Optional]integer
limit,
[advanced][Optional]string
with,
[advanced][Optional]string
filter)
PostToMyTimeline Post to my timeline
(UserPostFeedRequest post)
UserTimeline (string userId, Get user timeline
[advanced][Optional]integer
limit,
[advanced][Optional]string
with,
[advanced][Optional]string
filter, [Optional]string fields)
PageFeed (string pageId, Get page feed
[advanced][Optional]integer
limit,

728 | P a g e
 Facebook

[advanced][Optional]boolean
include_hidden,
[Optional]string fields)
PostToPage (string pageId, Post to page
PagePostFeedRequest post)
PublishPhoto Publish Photo
(PostPhotoRequest photo)
PublishVideo Publish Video
(PostVideoRequest message)
ReadProfilePicture (string Get Profile Picture
user-id)
ReadEventsFromPage (string Get Page Events
page-id)

Triggers:
Name Summary
TriggerNewPost () When there is a new post on my timeline

Objects:
Name Summary
ActionItem
AdminItem
ChildAttachmentsItem
FeedTargetItem
GetEventResponse
GetEventResponseItem
GetFeedResponse
GetPhotoResponse

729 | P a g e
 Facebook

GetPhotoResponseItem
LocationItem
PagePostFeedRequest
PlaceItem
PostFeedResponse
PostItem
PostPhotoRequest
PostPhotoResponse
PostVideoRequest
PrivacyItem
ProfileCollection
PropertyItem
TargetItem
TriggerFeedResponse
TriggerItem
UserItem
UserPostFeedRequest

Actions:
MyTimeline
Summary: Get feed from my timeline
Description: Gets the feeds from the logged in user's timeline

Syntax:
Facebook.MyTimeline ([Optional]string fields,
[advanced][Optional]integer limit, [advanced][Optional]string
with, [advanced][Optional]string filter)

Parameters:

730 | P a g e
 Facebook

Name Type Summary Required Related

Action
fields string Specify the fields False
(Fields) you want
returned.
Example
(id,name,picture).
limit integer(int32) Maximum False
(Max posts) number of posts
to be retrieved
with string Restrict the list of False
(With or without posts to only
location)Values: those with
[location] location
attached.
filter string Retrieve only False
(Filter for the posts that match
feeds a particular
returned)Values: stream filter.
[np,
app_2915120374,
app_2305272732,
app_2309869772,
pp,
app_2392950137,
app_2347471856,
app_2361831622]

Returns:

731 | P a g e
 Facebook

Type:GetFeedResponse

PostToMyTimeline
Summary: Post to my timeline
Description: Post a status message to the logged in user's timeline

Syntax:
Facebook.PostToMyTimeline (UserPostFeedRequest post)

Parameters:
Name Type Summary Required Related
Action
post UserPostFeedRequest True

Returns:
Type:PostFeedResponse

UserTimeline
Summary: Get user timeline
Description: Get posts from a user's timeline

Syntax:
Facebook.UserTimeline (string userId,
[advanced][Optional]integer limit, [advanced][Optional]string
with, [advanced][Optional]string filter, [Optional]string
fields)

Parameters:

732 | P a g e
 Facebook

Name Type Summary Required Related

Action
userId string Unique ID of the True
(User ID) user whose
timeline have to
be retrieved.
limit integer(int32) Maximum False
(Max posts) number of posts
to be retrieved
with string Restrict the list of False
(With or without posts to only
location)Values: those with
[location] location
attached.
filter string Retrieve only False
(Filter for the posts that match
feeds a particular
returned)Values: stream filter.
[np,
app_2915120374,
app_2305272732,
app_2309869772,
pp,
app_2392950137,
app_2347471856,
app_2361831622]
fields string Specify the fields False
(Fields) you want
returned.

733 | P a g e
 Facebook

Example
(id,name,picture).

Returns:
Type:GetFeedResponse

PageFeed
Summary: Get page feed
Description: Get posts from the feed of a specified page

Syntax:
Facebook.PageFeed (string pageId, [advanced][Optional]integer
limit, [advanced][Optional]boolean include_hidden,
[Optional]string fields)

Parameters:
Name Type Summary Required Related
Action
pageId string Unique ID of the True
(Page ID) page from which
posts have to be
retrieved.
limit integer(int32) Maximum False
(Max posts) number of posts
to be retrieved
include_hidden boolean Whether or not False
(Include to include any
hidden posts that were
posts.)

734 | P a g e
 Facebook

hidden by the
Page
fields string Specify the fields False
(Fields) you want
returned.
Example
(id,name,picture).

Returns:
Type:GetFeedResponse

PostToPage
Summary: Post to page
Description: Post a message to a Facebook Page as the logged in user

Syntax:
Facebook.PostToPage (string pageId, PagePostFeedRequest post)

Parameters:
Name Type Summary Required Related
Action
pageId string Unique ID of True
(Page ID) the page to
post to.
post PagePostFeedRequest True

Returns:
Type:PostFeedResponse

735 | P a g e
 Facebook

PublishPhoto
Summary: Publish Photo
Description: Publish a photo to the specified Facebook Page or to the User's timeline.

Syntax:
Facebook.PublishPhoto (PostPhotoRequest photo)

Parameters:
Name Type Summary Required Related
Action
photo PostPhotoRequest True

Returns:
Type:PostPhotoResponse

PublishVideo
Summary: Publish Video
Description: Publish a video to the specified Facebook page or to the user's timeline.

Syntax:
Facebook.PublishVideo (PostVideoRequest message)

Parameters:
Name Type Summary Required Related
Action
message PostVideoRequest True

736 | P a g e
 Facebook

Returns:
Type:PostFeedResponse

ReadProfilePicture
Summary: Get Profile Picture
Description: Gets the User profile picture

Syntax:
Facebook.ReadProfilePicture (string user-id)

Parameters:
Name Type Summary Required Related
Action
user-id string Unique ID of the True
(User ID) user whose
profile picture
needs to be
retrieved.
Provide "me" if
you want to
retrieve your
profile picture

Returns:
Type:GetPhotoResponse

737 | P a g e
 Facebook

ReadEventsFromPage
Summary: Get Page Events
Description: Gets Events from the specified Facebook Page

Syntax:
Facebook.ReadEventsFromPage (string page-id)

Parameters:
Name Type Summary Required Related
Action
page-id string Unique ID of the True
(Page ID) page from which
events are to be
retrieved.

Returns:
Type:GetEventResponse

Triggers:
Trigger TriggerNewPost
Summary: When there is a new post on my timeline
Description: Triggers a new flow when there is a new post on the logged in user's
timeline

Syntax:
Facebook.TriggerNewPost ()

Returns:
Type:TriggerFeedResponse

738 | P a g e
 Facebook

739 | P a g e
 Facebook

ActionItem
Summary:
Description:

Properties:
Name Type Summary
name string The name or label of the
action link.
link string The URL of the action link
itself.

740 | P a g e
 Facebook

AdminItem
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Unique ID of the admin
user
name string Name of the admin

741 | P a g e
 Facebook

ChildAttachmentsItem
Summary:
Description:

Properties:
Name Type Summary
link string The URL of a link to attach
to the post.
picture string(uri) Determines the preview
image associated with the
link (1:1 aspect ratio and a
minimum of 458 x 458 px
for best display).
image_hash string Hash of a preview image
associated with the link
from your ad image library
(1:1 aspect ratio and a
minimum of 458 x 458 px
for best display).
name string The title of the link
preview.
description string Used to show either a
price, discount or website
domain.

742 | P a g e
 Facebook

FeedTargetItem
Summary:
Description: Object that controls news feed targeting for this post. Anyone in these
groups will be more likely to see this post, others will be less likely. Applies to Pages
only.

Properties:
Name Type Summary
countries array of (string) Values of targeting
countries.
regions array of (integer(int32)) Values for targeted
regions.
cities array of (integer(int32)) Values for excluded
cities.
age_min integer(int32) Must be 13 or higher.

age_max integer(int32) Maximum Age.

genders array of (integer(int32)) Target specific genders. 1

targets all male viewers
and 2 females. Default is
to target both.
relationship_statuses array of (integer(int32)) Array of integers for
targeting based on
relationship status.
interested_in array of (integer(int32)) Indicates targeting based
on the 'interested in' field
of the user profile.

743 | P a g e
 Facebook

college_years array of (integer(int32)) Array of integers for

graduation year from
college.
education_statuses array of (integer(int32)) Array of integers for
targeting based on
education level.
locales array of (integer(int32)) Targeted locales.

744 | P a g e
 Facebook

GetEventResponse
Summary:
Description:

Properties:
Name Type Summary
data array of
(GetEventResponseItem)
Data

745 | P a g e
 Facebook

GetEventResponseItem
Summary:
Description:

Properties:
Name Type Summary
id string
Event ID
name string
Event Name
start_time string
Start Time
end_time string
End Time
timezone string
Timezone
location string
Location
description string
Description
ticket_uri string
Ticket Uri
rsvp_status string
RSVP Status

746 | P a g e
 Facebook

GetFeedResponse
Summary:
Description:

Properties:
Name Type Summary
data array of (PostItem)
Response Data

747 | P a g e
 Facebook

GetPhotoResponse
Summary:
Description:

Properties:
Name Type Summary
data GetPhotoResponseItem

748 | P a g e
 Facebook

GetPhotoResponseItem
Summary:
Description:

Properties:
Name Type Summary
url string
Photo Url
is_silhouette boolean
Is Silhoutte?
height string
Height
width string
Width

749 | P a g e
 Facebook

LocationItem
Summary:
Description:

Properties:
Name Type Summary
city string City of the location

country string Country of the location

latitude number(float) Latitude of the location

located_in string The parent location if this

location is located within
another location.
longitude number(float) Longitude of the location

name string Name of the location

region string Name of the location

region
state string State which the location is
in.
street string Street which the location
is on.
zip string Location Zip Code.

750 | P a g e
 Facebook

PagePostFeedRequest
Summary:
Description:

Properties:
Name Type Summary
message string The main body of the
post, otherwise called
the status message.
link string(uri) The URL of a link to
attach to the post.
picture string(uri) Determines the preview
image associated with
the link.
name string Overwrites the title of
the link preview.
caption string Overwrites the caption
under the title in the
link preview.
description string Overwrites the
description in the link
preview.
actions array of (ActionItem) The action links
attached to the post.
place string Page ID of a location
associated with this
post

751 | P a g e
 Facebook

tags string Comma-separated list

of user IDs of people
tagged in this post.
object_attachment string Facebook ID for an
existing picture in the
person's photo albums
to use as the thumbnail
image.
targeting TargetItem

feed_targeting FeedTargetItem Object that controls

news feed targeting for
this post. Anyone in
these groups will be
more likely to see this
post, others will be less
likely. Applies to Pages
only.
published boolean Whether a story is
shown about this newly
published object.
scheduled_publish_time string(date-time) Time when this post
should go live, this can
be any date between
ten minutes and six
months from the time
of the API call.

752 | P a g e
 Facebook

backdated_time string(date-time) Specifies a time in the

past to back-date this
post to.
backdated_time_granularity string Controls the display of
how a backdated post
appears. Values: [year,
month, day, hour,
minute]
child_attachments array of Use to specify multiple
(ChildAttachmentsItem) links in the post.

multi_share_end_card boolean If set to false, does not

display the end card of
a carousel link post
when
child_attachments is
used.

753 | P a g e
 Facebook

PlaceItem
Summary:
Description:

Properties:
Name Type Summary
id string Unique ID of the place

name string Name of the place

overall_rating number(float) Overall rating of place, on

a 5-star scale. 0 means
not enough data to get a
combined rating.
location LocationItem

754 | P a g e
 Facebook

PostFeedResponse
Summary:
Description:

Properties:
Name Type Summary
id string

755 | P a g e
 Facebook

PostItem
Summary:
Description: An individual entry in a profile's feed. The profile could be a user, page,
app, or group.

Properties:
Name Type Summary
id string Unique ID of the post

admin_creator array of (AdminItem) Unique ID of admin who

created the post. Applies to
pages only.
caption string The caption of a link in the
post (appears beneath the
name).
created_time string(date-time) The time the post was
initially published. For a
post about a life event, this
will be the date and time of
the life event.
description string A description of a link in the
post (appears beneath the
caption).
feed_targeting FeedTargetItem Object that controls news
feed targeting for this post.
Anyone in these groups will
be more likely to see this
post, others will be less
likely. Applies to Pages only.

756 | P a g e
 Facebook

from UserItem

icon string A link to an icon

representing the type of
this post.
is_hidden boolean If this post is marked as
hidden (applies to Pages
only).
is_published boolean Indicates whether a
scheduled post was
published (applies to
scheduled Page Post only,
for users post and instanlty
published posts this value is
always true).
link string(uri) The link attached to this
post.
message string The status message in the
post.
name string The name of the link.

object_id string The ID of any uploaded

photo or video attached to
the post.
picture string(uri) The picture scraped from
any link included with the
post.
place PlaceItem

757 | P a g e
 Facebook

privacy PrivacyItem

properties array of (PropertyItem) A list of properties for any

attached video, for
example, the length of the
video.
source string(uri) A URL to any Flash movie or
video file attached to the
post.
status_type string Description of the type of a
status update. Values:
[mobile_status_update,
created_note,
added_photos,
added_video, shared_story,
created_group,
created_event, wall_post,
app_created_story,
published_story,
tagged_in_photo,
approved_friend]
story string Text from stories not
intentionally generated by
users, such as those
generated when two
people become friends, or
when someone else posts
on the person's wall.
targeting TargetItem

758 | P a g e
 Facebook

to array of (ProfileCollection) Profiles mentioned or

targeted in this post.
type string A string indicating the
object type of this post.
Values: [link, status, photo,
video, offer]
updated_time string(date-time) The time of the last change
to this post, or the
comments on it
with_tags ProfileCollection

759 | P a g e
 Facebook

PostPhotoRequest
Summary:
Description:

Properties:
Name Type Summary
url string The url for the image.
Image Url
caption string Caption of the image.
Caption

760 | P a g e
 Facebook

PostPhotoResponse
Summary:
Description:

Properties:
Name Type Summary
id string
Id
post_id string
Post ID

761 | P a g e
 Facebook

PostVideoRequest
Summary:
Description:

Properties:
Name Type Summary
videoData string Base-64 encoded string
Video representing a video
description string Description of the video
Video Description
title string Title of the video
Video Title
uploadedVideoName string Name of the video
Video Name

762 | P a g e
 Facebook

PrivacyItem
Summary:
Description:

Properties:
Name Type Summary
description string Text that describes the
privacy settings, as they
would appear in Facebook.
value string The value of the privacy
setting. Values:
[EVERYONE, ALL_FRIENDS,
FRIENDS_OF_FRIENDS,
SELF, CUSTOM]
allow string When value is CUSTOM, this
is a comma-separated list of
user IDs and friend list IDs
that can see the post.
deny string When value is CUSTOM, this
is a comma-separated list of
user IDs and friend list IDs
that cannot see the post.
friends string When value is CUSTOM, this
indicates which group of
friends can see the post.
Values: [ALL_FRIENDS,
FRIENDS_OF_FRIENDS,
SOME_FRIENDS]

763 | P a g e
 Facebook

ProfileCollection
Summary:
Description:

Properties:
Name Type Summary
data array of (UserItem)

764 | P a g e
 Facebook

PropertyItem
Summary:
Description:

Properties:
Name Type Summary
name string The property name.

text string The value of the property.

href string(uri) Any link associated with

the property.

765 | P a g e
 Facebook

TargetItem
Summary:
Description:

Properties:
Name Type Summary
countries array of (string) Values of targeting
countries.
locales array of (integer(int32)) Targeted locales.

regions array of (integer(int32)) Values for targeted

regions.
cities array of (integer(int32)) Values for excluded cities.

766 | P a g e
 Facebook

TriggerFeedResponse
Summary:
Description:

Properties:
Name Type Summary
data array of (TriggerItem)
Response Data

767 | P a g e
 Facebook

TriggerItem
Summary:
Description: An individual entry in a profile's feed. The profile could be a user, page,
app, or group.

Properties:
Name Type Summary
id string The post ID

created_time string(date-time) The time the post was

initially published. For a
post about a life event,
this will be the date and
time of the life event.
from UserItem

message string The status message in the

post.
type string A string indicating the
object type of this post.
Values: [link, status,
photo, video, offer]

768 | P a g e
 Facebook

UserItem
Summary:
Description:

Properties:
Name Type Summary
id string Unique ID of the user

first_name string User first name

last_name string User last name

name string User full name

gender string Gender of the user

about string User bio

769 | P a g e
 Facebook

UserPostFeedRequest
Summary:
Description:

Properties:
Name Type Summary
message string The main body of the
post, otherwise called the
status message.
link string(uri) The URL of a link to attach
to the post.
picture string(uri) Determines the preview
image associated with the
link.
name string Overwrites the title of the
link preview.
caption string Overwrites the caption
under the title in the link
preview.
description string Overwrites the
description in the link
preview.
place string Page ID of a location
associated with this post
tags string Comma-separated list of
user IDs of people tagged
in this post.
privacy PrivacyItem

770 | P a g e
 Facebook

object_attachment string Facebook ID for an

existing picture in the
person's photo albums to
use as the thumbnail
image.

771 | P a g e
 Flic

Flic
The Flic connector allows a workflow to be triggered by the press of a Flic
button or Flic task, in combination with the Flic Android or iOS app.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
DeleteTrigger (string Delete a webhook
user_uuid, string hook_Id)
ButtonList () Get Flic list
TaskList () Get Task list

Triggers:
Name Summary
FlicButtonTrigger (string When a Flic is pressed
button_uuid,
WebhookRequestBodyFlic Request
body of webhook)
FlicTaskTrigger (string task_uuid, When a Task is executed
[Optional]WebhookRequestBodyTask
Request body of webhook)

Objects:
Name Summary
GetFlicsResponse
GetTasksResponse

772 | P a g e
 Flic

WebhookRequestBodyFlic
WebhookRequestBodyTask

Actions:
DeleteTrigger
Summary: Delete a webhook
Description: Deletes a webhook

Syntax:
Flic.DeleteTrigger (string user_uuid, string hook_Id)

Parameters:
Name Type Summary Required Related
Action
user_uuid string User UUID True

hook_Id string ID of hook True

Returns:

ButtonList
Summary: Get Flic list
Description: Gets Flic list

Syntax:
Flic.ButtonList ()

773 | P a g e
 Flic

Returns:
Type:GetFlicsResponse

TaskList
Summary: Get Task list
Description: Gets Task list

Syntax:
Flic.TaskList ()

Returns:
Type:GetTasksResponse

Triggers:
Trigger FlicButtonTrigger
Summary: When a Flic is pressed
Description: Triggers a workflow when the configured Flic is pressed.

Syntax:
Flic.FlicButtonTrigger (string button_uuid,
WebhookRequestBodyFlic Request body of webhook)

Parameters:
Name Type Summary Required Related
Action
button_uuid string The Flic that True ButtonList
(Flic button) will trigger

774 | P a g e
 Flic

the
workflow.
Request body of WebhookRequestBodyFlic True
webhook

Returns:

Trigger FlicTaskTrigger
Summary: When a Task is executed
Description: Triggers a workflow when the configured Task is executed.

Syntax:
Flic.FlicTaskTrigger (string task_uuid,
[Optional]WebhookRequestBodyTask Request body of webhook)

Parameters:
Name Type Summary Required Related
Action
task_uuid string The Task True TaskList
(Task) that will
trigger the
workflow.
Request body of WebhookRequestBodyTask False
webhook

Returns:

775 | P a g e
 Flic

GetFlicsResponse
Summary:
Description:

Properties:
Name Type Summary
buttons array of (ButtonsItem)

ButtonsItem
Summary:
Description:

Properties:
Name Type Summary
name string Name of Flic

button_uuid string Button UUID

776 | P a g e
 Flic

GetTasksResponse
Summary:
Description:

Properties:
Name Type Summary
tasks array of (TasksItem)

TasksItem
Summary:
Description:

Properties:
Name Type Summary
name string Name of Task

task_uuid string Task UUID

777 | P a g e
 Flic

WebhookRequestBodyFlic
Summary:
Description:

Properties:
Name Type Summary
url string Url
Url
events string Events to listen to Values:
Events [click, double click, hold,
any]

778 | P a g e
 Flic

WebhookRequestBodyTask
Summary:
Description:

Properties:
Name Type Summary
url string Url
Url

779 | P a g e
 FreshBooks

FreshBooks
FreshBooks is a cloud based small business accounting software. Send
invoices, track time, manage receipts and expenses.

Status: Preview Tier: Premium Version: 1.0.0

Actions:
Name Summary
ListExpenses ([internal]integer List expenses
per_page, string accountid)
AddExpense ([internal]integer Create new expense
per_page, string accountid,
AddExpenseParameterBody
body)
UpdateExpense Update expense
([internal]integer per_page,
string accountid, string
expenseid,
UpdateExpenseParameterBody
body)
DeleteExpense Delete expense
([internal]integer per_page,
string accountid, string
expenseid,
DeleteExpenseParameterBody
body)
ListStaff ([internal]integer List Staff
per_page, string accountid)

780 | P a g e
 FreshBooks

ListCategory ([internal]integer List Category

per_page, string accountid)
AddClient ([internal]integer Add new client
per_page, string accountid,
AddClientParameterBody
body)
MyUserInformation () My User Information
ListVendors ([internal]integer List Vendors
per_page, string accountid)

Triggers:
Name Summary
TrigUpdatedExpense When an expense is created or updated
([internal]integer per_page,
string accountid)

Objects:
Name Summary
AddClientParameterBody
AddExpenseParameterBody
Client
DeleteExpenseParameterBody
Expense
ListCategoryResponseItem
ListStaffResponseItem
ListVendorsResponseItem
MyUserInformationResponseItem
UpdateExpenseParameterBody

781 | P a g e
 FreshBooks

Actions:
ListExpenses
Summary: List expenses
Description: Retrieves a list of all your expenses.

Syntax:
FreshBooks.ListExpenses ([internal]integer per_page, string
accountid)

Parameters:
Name Type Summary Required Related Action
per_page integer True

accountid string True MyUserInformation

(Account)

Returns:
Type:array of (Expense)
Summary: Expenses
Description: Array of expenses.

AddExpense
Summary: Create new expense
Description: This operation creates a new expense in your account.

Syntax:
FreshBooks.AddExpense ([internal]integer per_page, string
accountid, AddExpenseParameterBody body)

782 | P a g e
 FreshBooks

Parameters:
Name Type Summar Require Related Action
y d
per_page integer True

accounti string True MyUserInformatio

d (Account) n
body AddExpenseParameterBod True
y

Returns:
Type:Expense

UpdateExpense
Summary: Update expense
Description: This operation is used to update an existing expense in your account.

Syntax:
FreshBooks.UpdateExpense ([internal]integer per_page, string
accountid, string expenseid, UpdateExpenseParameterBody body)

Parameters:
Name Type Summar Require Related Action
y d
per_page integer True

783 | P a g e
 FreshBooks

accounti string True MyUserInformatio

d (Account) n
expensei string True
d (Expense Id)
body UpdateExpenseParameterBo True
dy

Returns:

DeleteExpense
Summary: Delete expense
Description: This operation is used to delete an existing expense from your account.

Syntax:
FreshBooks.DeleteExpense ([internal]integer per_page, string
accountid, string expenseid, DeleteExpenseParameterBody body)

Parameters:
Name Type Summar Require Related Action
y d
per_page integer True

accounti string True MyUserInformatio

d (Account) n
expensei string True
d (Expense Id)
body DeleteExpenseParameterBo True
dy

784 | P a g e
 FreshBooks

Returns:

ListStaff
Summary: List Staff
Description: List staff.

Syntax:
FreshBooks.ListStaff ([internal]integer per_page, string
accountid)

Parameters:
Name Type Summary Required Related Action
per_page integer True

accountid string True MyUserInformation

(Account)

Returns:
Type:array of (ListStaffResponseItem)
Summary: staff
Description: staff

ListCategory
Summary: List Category
Description: List categories.

Syntax:

785 | P a g e
 FreshBooks

FreshBooks.ListCategory ([internal]integer per_page, string

accountid)

Parameters:
Name Type Summary Required Related Action
per_page integer True

accountid string True MyUserInformation

(Account)

Returns:
Type:array of (ListCategoryResponseItem)
Summary: categories
Description: categories

AddClient
Summary: Add new client
Description: This operation creates a new client in your account.

Syntax:
FreshBooks.AddClient ([internal]integer per_page, string
accountid, AddClientParameterBody body)

Parameters:
Name Type Summary Required Related Action
per_page integer True

accountid string True MyUserInformation

(Account)

786 | P a g e
 FreshBooks

body AddClientParameterBody True

Returns:
Type:Client

MyUserInformation
Summary: My User Information
Description: Get my user information.

Syntax:
FreshBooks.MyUserInformation ()

Returns:
Type:array of (MyUserInformationResponseItem)
Summary: business_memberships
Description: business_memberships

ListVendors
Summary: List Vendors
Description: List vendors.

Syntax:
FreshBooks.ListVendors ([internal]integer per_page, string
accountid)

Parameters:
Name Type Summary Required Related Action
per_page integer True

787 | P a g e
 FreshBooks

accountid string True MyUserInformation

(Account)

Returns:
Type:array of (ListVendorsResponseItem)
Summary: vendors
Description: vendors

Triggers:
Trigger TrigUpdatedExpense
Summary: When an expense is created or updated
Description: Triggers when a new expense is created or an existing one is updated.

Syntax:
FreshBooks.TrigUpdatedExpense ([internal]integer per_page,
string accountid)

Parameters:
Name Type Summary Required Related Action
per_page integer True

accountid string True MyUserInformation

(Account)

Returns:
Type:array of (Expense)
Summary: Expenses
Description: Array of expenses.

788 | P a g e
 FreshBooks

789 | P a g e
 FreshBooks

AddClientParameterBody
Summary:
Description:

Properties:
Name Type Summary
client Client client

Client
Summary:
Description: client

Properties:
Name Type Summary
fname string
First Name
lname string
Last Name
organization string
Organization
email string
Email Address
bus_phone string
Phone Number
currency_code string 3-letter currency code.
Currency Values: [AED, AMD, ANG,
ARS, AUD, AWG, AZN,
BAM, BBD, BDT, BGN,

790 | P a g e
 FreshBooks

BHD, BIF, BMD, BND,

BOB, BOV, BRL, BSD, BTN,
BWP, BYN, BYR, BZD,
CAD, CDF, CHE, CHF,
CHW, CLF, CLP, CNY, COP,
COU, CRC, CUC, CUP, CVE,
CZK, DJF, DKK, DOP, EGP,
ERN, ETB, EUR, FJD, FKP,
GBP, GEL, GHS, GIP, GMD,
GNF, GTQ, GYD, HKD,
HNL, HRK, HTG, HUF, IDR,
ILS, INR, IQD, IRR, ISK,
JMD, JOD, JPY, KES, KGS,
KHR, KMF, KPW, KRW,
KWD, KYD, KZT, LAK, LBP,
LKR, LRD, LSL, LYD, MAD,
MDL, MGA, MKD, MMK,
MNT, MOP, MRO, MUR,
MVR, MWK, MXN, MXV,
MYR, MZN, NAD, NGN,
NIO, NOK, NPR, NZD,
OMR, PAB, PEN, PGK,
PHP, PKR, PLN, PYG, QAR,
RON, RSD, RUB, RWF,
SAR, SBD, SCR, SDG, SEK,
SGD, SHP, SLL, SOS, SRD,
SSP, STD, SVC, SYP, SZL,
THB, TJS, TMT, TND, TOP,
TRY, TTD, TWD, TZS, UAH,

791 | P a g e
 FreshBooks

UGX, USD, USN, UYI, UYU,

UZS, VEF, VND, VUV, WST,
XAF, XAG, XAU, XBA, XBB,
XBC, XBD, XCD, XDR, XOF,
XPD, XPF, XPT, XSU, XTS,
XUA, XXX, YER, ZAR,
ZMW, ZWL]
p_street string
Street Address 1
p_street2 string
Street Address 2
p_city string
City
p_code string
Postal Code
p_country string
Country
p_province string
Province

792 | P a g e
 FreshBooks

AddExpenseParameterBody
Summary:
Description:

Properties:
Name Type Summary
expense Expense

Expense
Summary:
Description:

Properties:
Name Type Summary
amount Amount

categoryid integer(int32) Pick an expense category.

Category
staffid integer(int32) Pick the staff member to
Staff expense.
date string YYYY-MM-DD or ISO
Date format datetime.
vendor string Pick a vendor to expense.
Vendor
notes string
Notes

793 | P a g e
 FreshBooks

Amount
Summary:
Description:

Properties:
Name Type Summary
amount string
Amount
code string 3-letter currency code.
Currency Values: [AED, AMD, ANG,
ARS, AUD, AWG, AZN,
BAM, BBD, BDT, BGN,
BHD, BIF, BMD, BND, BOB,
BOV, BRL, BSD, BTN, BWP,
BYN, BYR, BZD, CAD, CDF,
CHE, CHF, CHW, CLF, CLP,
CNY, COP, COU, CRC, CUC,
CUP, CVE, CZK, DJF, DKK,
DOP, EGP, ERN, ETB, EUR,
FJD, FKP, GBP, GEL, GHS,
GIP, GMD, GNF, GTQ, GYD,
HKD, HNL, HRK, HTG, HUF,
IDR, ILS, INR, IQD, IRR, ISK,
JMD, JOD, JPY, KES, KGS,
KHR, KMF, KPW, KRW,
KWD, KYD, KZT, LAK, LBP,
LKR, LRD, LSL, LYD, MAD,
MDL, MGA, MKD, MMK,
MNT, MOP, MRO, MUR,

794 | P a g e
 FreshBooks

MVR, MWK, MXN, MXV,

MYR, MZN, NAD, NGN,
NIO, NOK, NPR, NZD,
OMR, PAB, PEN, PGK, PHP,
PKR, PLN, PYG, QAR, RON,
RSD, RUB, RWF, SAR, SBD,
SCR, SDG, SEK, SGD, SHP,
SLL, SOS, SRD, SSP, STD,
SVC, SYP, SZL, THB, TJS,
TMT, TND, TOP, TRY, TTD,
TWD, TZS, UAH, UGX, USD,
USN, UYI, UYU, UZS, VEF,
VND, VUV, WST, XAF, XAG,
XAU, XBA, XBB, XBC, XBD,
XCD, XDR, XOF, XPD, XPF,
XPT, XSU, XTS, XUA, XXX,
YER, ZAR, ZMW, ZWL]

795 | P a g e
 FreshBooks

Client
Summary:
Description:

Properties:
Name Type Summary
response Response response

Response
Summary:
Description: response

Properties:
Name Type Summary
result Result result

Result
Summary:
Description: result

Properties:
Name Type Summary
client Client client

Client
Summary:

796 | P a g e
 FreshBooks

Description: client

Properties:
Name Type Summary
fname string Client's first name.
First Name
lname string Client's last name.
Last Name
fax string Client's fax number.
Fa Number
vat_number string Value added tax number.
VAT Number
vat_name string Value added tax name.
VAT Name
id integer(int32) Unique to this business id
Client Id for client.
s_province string Shipping address.
Province
s_country string Shipping address.
Country
s_city string Shipping address.
City
s_street string Shipping address.
Street
s_street2 string Shipping address.
Street 2
s_code string Shipping address.
Postal Code

797 | P a g e
 FreshBooks

note string Notes kept by admin

Note about client.
mob_phone string Mobile phone number.
Mobile Phone
home_phone string Home phone number.
Home Phone
company_industry string Description of industry
Company Industry client is in.
email string Client's email.
Email
username string Username used by client
Username to log in.
updated string Updated
Updated
p_province string Billing address.
Province
p_country string Billing address.
Country
p_city string Billing address.
City
p_street string Billing address.
Street
p_code string Billing address.
Postal Code
p_street2 string Billing address.
Street 2
bus_phone string Billing address.
Phone
company_size string Billing address.

798 | P a g e
 FreshBooks

Size
accounting_systemid string Unique identifier of
System Id business client exists on.
language string Shortcode indicating user
Language language.
organization string Name for client's
Organization business.
currency_code string 3-letter shortcode for
Currency Code preferred currency.

799 | P a g e
 FreshBooks

DeleteExpenseParameterBody
Summary:
Description:

Properties:
Name Type Summary
expense Expense expense
expense

Expense
Summary: expense
Description: expense

Properties:
Name Type Summary
vis_state integer(int32) vis_state
vis_state

800 | P a g e
 FreshBooks

Expense
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Unique to this business id
Expense ID for expense.
markup_percent string Decimal, percent to mark
Markup Percent expense up.
projectid integer(int32) Id of related project, if
Project Id applicable.
clientid integer(int32) Id of related client, if
Client Id applicable.
taxPercent1 string Decimal, first tax percent.
Tax Percent 1
taxName1 string Name of first tax.
Tax Name 1
taxAmount1 string Amount of first tax.
Tax Amount 1
taxPercent2 string Decimal, second tax
Tax Percent 2 percent.
taxName2 string Name of second tax.
Tax Name 2
taxAmount2 string Amount of second tax.
Tax Amount 2
invoiceid string Id of related invoice, if
Invoice Id applicable.

801 | P a g e
 FreshBooks

status integer(int32) Value from the expense

Status status table.
bank_name string Name of bank expense
Bank Name was imported from, if
applicable.
updated string When the expense was
Updated last updated.
vendor string Name of vendor.
Vendor
has_receipt boolean True if the receipt is
Has Receipt attached.
ext_systemid integer(int32) Id of related contractor
External System Id system, if applicable.
date string Date of the expense.
Date
transactionid string Id of related transaction,
Transaction Id if applicable.
notes string Expense notes.
Notes
account_name string Name of related account,
Account Name if applicable.
amount Amount

compounded_tax boolean True if tax 2 was a

Compounded Tax compounded tax.
accountid string Id of expense account, if
Account Id applicable.

802 | P a g e
 FreshBooks

Amount
Summary:
Description:

Properties:
Name Type Summary
amount string Decimal value.
Amount
code string 3-letter currency code.
Currency Code

803 | P a g e
 FreshBooks

ListCategoryResponseItem
Summary:
Description:

Properties:
Name Type Summary
category string category
category
id integer(int32) id
id

804 | P a g e
 FreshBooks

ListStaffResponseItem
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) id
id
display_name string display_name
display_name

805 | P a g e
 FreshBooks

ListVendorsResponseItem
Summary:
Description:

Properties:
Name Type Summary
vendor string vendor
vendor

806 | P a g e
 FreshBooks

MyUserInformationResponseItem
Summary:
Description:

Properties:
Name Type Summary
business Business

Business
Summary:
Description:

Properties:
Name Type Summary
name string
Name
account_id string
Account Id

807 | P a g e
 FreshBooks

UpdateExpenseParameterBody
Summary:
Description:

Properties:
Name Type Summary
expense Expense

Expense
Summary:
Description:

Properties:
Name Type Summary
amount Amount

categoryid integer(int32) Pick an expense category.

Category
staffid integer(int32) Pick the staff member to
Staff expense.
date string YYYY-MM-DD or ISO
Date format datetime.
vendor string Pick a vendor to expense.
Vendor
notes string
Notes

808 | P a g e
 FreshBooks

Amount
Summary:
Description:

Properties:
Name Type Summary
amount string
Amount
code string 3-letter currency code.
Currency Values: [AED, AMD, ANG,
ARS, AUD, AWG, AZN,
BAM, BBD, BDT, BGN,
BHD, BIF, BMD, BND, BOB,
BOV, BRL, BSD, BTN, BWP,
BYN, BYR, BZD, CAD, CDF,
CHE, CHF, CHW, CLF, CLP,
CNY, COP, COU, CRC, CUC,
CUP, CVE, CZK, DJF, DKK,
DOP, EGP, ERN, ETB, EUR,
FJD, FKP, GBP, GEL, GHS,
GIP, GMD, GNF, GTQ, GYD,
HKD, HNL, HRK, HTG, HUF,
IDR, ILS, INR, IQD, IRR, ISK,
JMD, JOD, JPY, KES, KGS,
KHR, KMF, KPW, KRW,
KWD, KYD, KZT, LAK, LBP,
LKR, LRD, LSL, LYD, MAD,
MDL, MGA, MKD, MMK,
MNT, MOP, MRO, MUR,

809 | P a g e
 FreshBooks

MVR, MWK, MXN, MXV,

MYR, MZN, NAD, NGN,
NIO, NOK, NPR, NZD,
OMR, PAB, PEN, PGK, PHP,
PKR, PLN, PYG, QAR, RON,
RSD, RUB, RWF, SAR, SBD,
SCR, SDG, SEK, SGD, SHP,
SLL, SOS, SRD, SSP, STD,
SVC, SYP, SZL, THB, TJS,
TMT, TND, TOP, TRY, TTD,
TWD, TZS, UAH, UGX, USD,
USN, UYI, UYU, UZS, VEF,
VND, VUV, WST, XAF, XAG,
XAU, XBA, XBB, XBC, XBD,
XCD, XDR, XOF, XPD, XPF,
XPT, XSU, XTS, XUA, XXX,
YER, ZAR, ZMW, ZWL]

810 | P a g e
 Freshdesk

Freshdesk
Freshdesk is a cloud-based customer support solution that will help you
streamline your customer service and make sure your customers receive the
support they deserve! The Freshdesk connector is intended for Freshdesk
agents to manage tickets and contacts.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
GetTickets Get tickets
([internal][Optional]string
updated_since)
CreateTicket Create a ticket
(CreateTicketBodySchema
body)
GetProducts () Get products
GetTicket (string ticketId) Get ticket
UpdateTicket (integer Update a ticket
ticketId,
UpdateTicketBodySchema
body)
GetContacts () Get Contacts
AddNote (integer ticketId, Add a note to a ticket
AddNoteBodySchema body)
GetAgents () Get Agents

811 | P a g e
 Freshdesk

Triggers:
Name Summary
TriggerTicketCreated When a ticket is created
([internal][Optional]string
updated_since)
TriggerTicketAssignedToAgent When a ticket assigned to an agent is updated
(integer agentId,
[internal][Optional]string
updated_since)
TriggerTicketUpdated When a ticket is updated
([Optional]integer ticketId,
[internal][Optional]string
updated_since)
TriggerTicketStatusChanged When a ticket status changes
(integer ticketId,
[Optional]string status)
TriggerAgentAdded () When an agent is added
TriggerContactAdded () When a contact is added

Objects:
Name Summary
AddNote200Response
AddNoteBodySchema
CreateTicket200Response
CreateTicketBodySchema
GetAgentsResponseItem
GetContactsResponseItem
GetProductsResponseItem

812 | P a g e
 Freshdesk

UpdateTicketBodySchema

Actions:
GetTickets
Summary: Get tickets
Description: Get all tickets.

Syntax:
Freshdesk.GetTickets ([internal][Optional]string updated_since)

Parameters:
Name Type Summary Required Related
Action
updated_since string Updated since False
(Updated
Since)

Returns:
Type:array of (CreateTicket200Response)

CreateTicket
Summary: Create a ticket
Description: Create a ticket.

Syntax:
Freshdesk.CreateTicket (CreateTicketBodySchema body)

Parameters:

813 | P a g e
 Freshdesk

Name Type Summary Required Related

Action
body CreateTicketBodySchema True

Returns:
Type:CreateTicket200Response

GetProducts
Summary: Get products
Description: Get a list of all products.

Syntax:
Freshdesk.GetProducts ()

Returns:
Type:array of (GetProductsResponseItem)

GetTicket
Summary: Get ticket
Description: Get a ticket by Id.

Syntax:
Freshdesk.GetTicket (string ticketId)

Parameters:
Name Type Summary Required Related
Action

814 | P a g e
 Freshdesk

ticketId string The ticket Id. True

(Ticket Id)

Returns:
Type:CreateTicket200Response

UpdateTicket
Summary: Update a ticket
Description: Update a ticket (only specified values will be updated).

Syntax:
Freshdesk.UpdateTicket (integer ticketId, UpdateTicketBodySchema
body)

Parameters:
Name Type Summary Required Related
Action
ticketId integer The ticket Id True GetTickets
(Ticket Id) to update.
body UpdateTicketBodySchema True

Returns:
Type:CreateTicket200Response

GetContacts
Summary: Get Contacts
Description: Get a list of contacts.

815 | P a g e
 Freshdesk

Syntax:
Freshdesk.GetContacts ()

Returns:
Type:array of (GetContactsResponseItem)

AddNote
Summary: Add a note to a ticket
Description: Add a private or public note to a ticket.

Syntax:
Freshdesk.AddNote (integer ticketId, AddNoteBodySchema body)

Parameters:
Name Type Summary Required Related
Action
ticketId integer The ticket Id True GetTickets
(Ticket Id) to add a note
to.
body AddNoteBodySchema True

Returns:
Type:AddNote200Response

GetAgents
Summary: Get Agents
Description: Get a list of all agents.

816 | P a g e
 Freshdesk

Syntax:
Freshdesk.GetAgents ()

Returns:
Type:array of (GetAgentsResponseItem)

Triggers:
Trigger TriggerTicketCreated
Summary: When a ticket is created
Description: When any ticket is created.

Syntax:
Freshdesk.TriggerTicketCreated ([internal][Optional]string
updated_since)

Parameters:
Name Type Summary Required Related
Action
updated_since string False
(Updated
Since)

Returns:
Type:array of (CreateTicket200Response)

Trigger TriggerTicketAssignedToAgent
Summary: When a ticket assigned to an agent is updated
Description: When any ticket assigned to the selected agent is updated.

817 | P a g e
 Freshdesk

Syntax:
Freshdesk.TriggerTicketAssignedToAgent (integer agentId,
[internal][Optional]string updated_since)

Parameters:
Name Type Summary Required Related
Action
agentId integer The agent id. True GetAgents
(Agent Id)
updated_since string False
(Updated
since)

Returns:
Type:array of (CreateTicket200Response)

Trigger TriggerTicketUpdated
Summary: When a ticket is updated
Description: When a ticket is updated.

Syntax:
Freshdesk.TriggerTicketUpdated ([Optional]integer ticketId,
[internal][Optional]string updated_since)

Parameters:
Name Type Summary Required Related
Action
ticketId integer The ticket Id. False GetTickets
(Ticket Id)

818 | P a g e
 Freshdesk

updated_since string False

(Updated
Since)

Returns:
Type:array of (CreateTicket200Response)

Trigger TriggerTicketStatusChanged
Summary: When a ticket status changes
Description: When the status of the ticket changes.

Syntax:
Freshdesk.TriggerTicketStatusChanged (integer ticketId,
[Optional]string status)

Parameters:
Name Type Summary Required Related
Action
ticketId integer The ticket Id. True GetTickets
(Ticket Id)
status string The new status False
(New of the ticket.
Status)Values:
[Open,
Pending,
Resolved,
Closed,
Waiting on
Customer,

819 | P a g e
 Freshdesk

Waiting on
Third Party]

Returns:
Type:CreateTicket200Response

Trigger TriggerAgentAdded
Summary: When an agent is added
Description: When an agent is added (for admin use only).

Syntax:
Freshdesk.TriggerAgentAdded ()

Returns:
Type:array of (GetAgentsResponseItem)

Trigger TriggerContactAdded
Summary: When a contact is added
Description: When a contact is added.

Syntax:
Freshdesk.TriggerContactAdded ()

Returns:
Type:array of (GetContactsResponseItem)

820 | P a g e
 Freshdesk

AddNote200Response
Summary:
Description:

Properties:
Name Type Summary
private boolean Set to true if the note is
Private private.
body string Content of the note in
Content HTML.
body_text string Content of the note in
Content Text plain text.
ticket_id integer(int32) Id of the ticket to which
Ticket Id this note is being added.
created_at string(date-time) Note creation timestamp
Created At (in format yyyy-MM-
ddTHH:mm:ssZ).
updated_at string(date-time) Note updated timestamp
Update At (in format yyyy-MM-
ddTHH:mm:ssZ).

821 | P a g e
 Freshdesk

AddNoteBodySchema
Summary:
Description:

Properties:
Name Type Summary
body string The content of the note.
Content
private boolean Indicates if this is a private
Private note (default is true).

822 | P a g e
 Freshdesk

CreateTicket200Response
Summary:
Description:

Properties:
Name Type Summary
spam boolean Set to true if the ticket has
Spam been marked as spam.
priority string Priority of the ticket.
Priority
requester_id integer(int32) User Id of the requester.
Requester Id
responder_id integer(int32) Id of the agent to whom
Agent Id the ticket has been
assigned.
source string The channel through
Source which the ticket was
created.
status string Status of the ticket.
Status
subject string Subject of the ticket.
Subject
id integer(int32) The unique Id of the ticket.
Ticket Id
type string Helps categorize the ticket
Type according to the different
kinds of issues your
support team deals with.

823 | P a g e
 Freshdesk

due_by string(date-time) Timestamp that denotes

Due By when the ticket is due to
be resolved (in format
yyyy-MM-ddTHH:mm:ssZ).
is_escalated boolean Set to true if the ticket has
Is Escalated been escalated for any
reason.
description string HTML content of the
Description ticket.
description_text string Content of the ticket in
Description Text plain text.
created_at string(date-time) Ticket creation timestamp
Created At (in format yyyy-MM-
ddTHH:mm:ssZ).
updated_at string(date-time) Ticket updated timestamp
Updated At (in format yyyy-MM-
ddTHH:mm:ssZ).

824 | P a g e
 Freshdesk

CreateTicketBodySchema
Summary:
Description:

Properties:
Name Type Summary
subject string The subject for the ticket.
Subject
description string The description for the
Description ticket.
email string The email of the
Email requester.
priority string The priority for the ticket.
Priority Values: [Low, Medium,
High, Urgent]
status string The status of the ticket.
Status Values: [Open, Pending,
Resolved, Closed, Waiting
on Customer, Waiting on
Third Party]
type string Helps categorize the ticket
Type according to the different
kinds of issues your
support team deals with.
due_by string(date-time) Timestamp that denotes
Due By when the ticket is due to
be resolved (in format
yyyy-MM-ddTHH:mm:ssZ).

825 | P a g e
 Freshdesk

fr_due_by string(date-time) Timestamp that denotes

First Response Due By when the first response is
due (in format yyyy-MM-
ddTHH:mm:ssZ).
responder_id integer(int32) The agent of the ticket.
Agent
product_id integer(int32) The product the ticket
Product should be part of (for
admin use only).

826 | P a g e
 Freshdesk

GetAgentsResponseItem
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) id
id
ticket_scope integer(int32) Ticket permission of the
Ticket Scope agent.
created_at string(date-time) Agent creation timestamp
Created At (in format yyyy-MM-
ddTHH:mm:ssZ).
updated_at string(date-time) Agent updated timestamp
Updated At (in format yyyy-MM-
ddTHH:mm:ssZ).
contact Contact Contact
Contact

Contact
Summary: Contact
Description: Contact

Properties:
Name Type Summary
active boolean Set to true if the agent is
Active verified.
email string Email address of the agent.
Email

827 | P a g e
 Freshdesk

job_title string Job title of the agent.

Job Title
language string Language of the agent.
Language
last_login_at string(date-time) Timestamp of the agent's
Last Login At last successful login (in
format yyyy-MM-
ddTHH:mm:ssZ).
mobile string Mobile number of the
Mobile agent.
name string Name of the agent.
Name
phone string Telephone number of the
Phone agent.
time_zone string Time zone of the agent.
Time Zone
created_at string(date-time) Agent Creation timestamp
Created At (in format yyyy-MM-
ddTHH:mm:ssZ).
updated_at string(date-time) Timestamp of the last
Updated At update to the agent (in
format yyyy-MM-
ddTHH:mm:ssZ).

828 | P a g e
 Freshdesk

GetContactsResponseItem
Summary:
Description:

Properties:
Name Type Summary
active boolean Set to true if the contact
Active has been verified.
address string Address of the contact.
Address
company_id string Id of the company to
Company Id which this contact belongs.
description string A short description of the
Description contact.
email string Primary email address of
Email the contact.
id integer(int32) Id of the contact.
Id
job_title string Job title of the contact.
Job Title
language string Language of the contact.
Language
mobile string Mobile number of the
Mobile contact.
name string Name of the contact.
Name
phone string Telephone number of the
Phone contact.

829 | P a g e
 Freshdesk

time_zone string Time zone in which the

Time Zone contact resides.
twitter_id string Twitter handle of the
Twitter Id contact.
created_at string(date-time) Contact creation
Created At timestamp (in format yyyy-
MM-ddTHH:mm:ssZ).
updated_at string(date-time) Contact updated
Updated At timestamp (in format yyyy-
MM-ddTHH:mm:ssZ).

830 | P a g e
 Freshdesk

GetProductsResponseItem
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Id.
id
name string Name.
name

831 | P a g e
 Freshdesk

UpdateTicketBodySchema
Summary:
Description:

Properties:
Name Type Summary
description string The ticket description.
Description
subject string The subject of the ticket.
Subject
priority string The priority of the ticket.
Priority Values: [Low, Medium,
High, Urgent]
status string The status of the ticket.
Status Values: [Open, Pending,
Resolved, Closed, Waiting
on Customer, Waiting on
Third Party]
type string Helps categorize the ticket
Type according to the different
kinds of issues your
support team deals with.
due_by string(date-time) Timestamp that denotes
Due By when the ticket is due to
be resolved (in format
yyyy-MM-ddTHH:mm:ssZ).
responder_id integer(int32) The agent of the ticket.
Agent

832 | P a g e
 GitHub

GitHub
GitHub is a web-based Git repository hosting service. It offers all of the
distributed revision control and source code management (SCM) functionality
of Git as well as adding its own features.

Status: Production Tier: Standard Version: 1.0

Actions:
Name Summary
CreateIssue (string Create an issue
repositoryOwner, string
repositoryName,
IssueBasicDetailsModel
issueBasicDetails)

Triggers:
Name Summary
IssueOpened () When a new issue is opened and assigned to me
IssueClosed () When an issue assigned to me is closed
IssueAssigned () When an issue is assigned to me

Objects:
Name Summary
IssueBasicDetailsModel
IssueDetailsModel

833 | P a g e
 GitHub

Actions:
CreateIssue
Summary: Create an issue
Description: Creates an issue

Syntax:
GitHub.CreateIssue (string repositoryOwner, string
repositoryName, IssueBasicDetailsModel issueBasicDetails)

Parameters:
Name Type Summary Required Related
Action
repositoryOwner string Repository True
(Repository owner owner
name)
repositoryName string Repository True
(Repository name) name
issueBasicDetails IssueBasicDetailsModel Issue details True
model

Returns:
Type:IssueDetailsModel
Description: Issue details model

Triggers:
Trigger IssueOpened
Summary: When a new issue is opened and assigned to me
Description: An issue is opened and assigned

834 | P a g e
 GitHub

Syntax:
GitHub.IssueOpened ()

Returns:
Type:array of (IssueDetailsModel)

Trigger IssueClosed
Summary: When an issue assigned to me is closed
Description: An assigned issue is closed

Syntax:
GitHub.IssueClosed ()

Returns:
Type:array of (IssueDetailsModel)

Trigger IssueAssigned
Summary: When an issue is assigned to me
Description: An issue is assigned

Syntax:
GitHub.IssueAssigned ()

Returns:
Type:array of (IssueDetailsModel)

835 | P a g e
 GitHub

IssueBasicDetailsModel
Summary:
Description: Issue details model

Properties:
Name Type Summary
title string Issue title
Issue title
body string Issue body
Issue body
assignee string Issue assignee
Issue assignee

836 | P a g e
 GitHub

IssueDetailsModel
Summary:
Description: Issue details model

Properties:
Name Type Summary
title string Issue title
Issue title
body string Issue body
Issue body
assignee string Issue assignee
Issue assignee
number string Issue id
Issue identifier
state string Issue state
Issue state
created_at string Issue created time
Issue created time
repository_url string Repository url
Repository url

837 | P a g e
 Gmail

Gmail
Gmail is a web-based email service from Google. With the Gmail connector,
you can perform actions such as send or receive e-mail messages, and trigger
flows on new e-mails.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
GetLabels () List all labels
GetEmail (string id, Get email details
[Optional]boolean
includeAttachments)
DeleteEmail (string id) Delete email
SendEmail (SendMessage Send email
emailMessage)
ReplyTo (string id, Reply to email
ReplyMessage replyMessage)
TrashEmail (string id) Move email to trash
TestConnection () Test connection

Triggers:
Name Summary
OnNewEmail ([Optional]string When a new email arrives
label,
[advanced][Optional]string to,
[advanced][Optional]string
from,

838 | P a g e
 Gmail

[advanced][Optional]string
subject,
[advanced][Optional]string
importance,
[advanced][Optional]string
starred,
[advanced][Optional]boolean
fetchOnlyWithAttachments,
[advanced][Optional]boolean
includeAttachments)

Objects:
Name Summary
Attachment
DetailedReceiveMessage
GmailLabel
ReplyMessage
SendMessage

Actions:
GetLabels
Summary: List all labels
Description: List all labels

Syntax:
Gmail.GetLabels ()

Returns:

839 | P a g e
 Gmail

Type:array of (GmailLabel)

GetEmail
Summary: Get email details
Description: Get details for a specific email

Syntax:
Gmail.GetEmail (string id, [Optional]boolean includeAttachments)

Parameters:
Name Type Summary Required Related
Action
id string Email ID True
(Message ID)
includeAttachments boolean If set to true, False
(Include attachments will
Attachments) also be retrieved
along with the
email

Returns:
Type:DetailedReceiveMessage
Description: Message details

DeleteEmail
Summary: Delete email
Description: Delete a specific email permanently

Syntax:

840 | P a g e
 Gmail

Gmail.DeleteEmail (string id)

Parameters:
Name Type Summary Required Related
Action
id string ID of the email to True
(Message delete
ID)

Returns:

SendEmail
Summary: Send email
Description: Send an email to specified recipients

Syntax:
Gmail.SendEmail (SendMessage emailMessage)

Parameters:
Name Type Summary Required Related
Action
emailMessage SendMessage Message to send True

Returns:

ReplyTo
Summary: Reply to email
Description: Reply to a specific email

841 | P a g e
 Gmail

Syntax:
Gmail.ReplyTo (string id, ReplyMessage replyMessage)

Parameters:
Name Type Summary Required Related
Action
id string Id of the email True
(Message ID) to reply to
replyMessage ReplyMessage Message to True
reply to another
message

Returns:

TrashEmail
Summary: Move email to trash
Description: Move a specific email to the trash

Syntax:
Gmail.TrashEmail (string id)

Parameters:
Name Type Summary Required Related
Action
id string ID of the email to True
(Message move to the
ID) trash

842 | P a g e
 Gmail

Returns:

TestConnection
Summary: Test connection
Description: Test the connection

Syntax:
Gmail.TestConnection ()

Returns:

Triggers:
Trigger OnNewEmail
Summary: When a new email arrives
Description: Triggers a flow when a new email matching the specified criteria arrives

Syntax:
Gmail.OnNewEmail ([Optional]string label,
[advanced][Optional]string to, [advanced][Optional]string from,
[advanced][Optional]string subject, [advanced][Optional]string
importance, [advanced][Optional]string starred,
[advanced][Optional]boolean fetchOnlyWithAttachments,
[advanced][Optional]boolean includeAttachments)

Parameters:
Name Type Summary Requir Relate
ed d
Action

843 | P a g e
 Gmail

label string Select a label (default: False GetLab

(Label) Inbox) els
to string(email) Example: False
(To) Recipient1;recipient2@do
main.com
from string(email) Example: Sender1 | False
(From) [email protected]
subject string String to look for in the False
(Subject) subject
importance string Should the email be False
(Importance)V important or not (default:
alues: [All, All)
Important,
Not
important]
starred string Should the email be False
(Starred)Value marked as starred or not
s: [All, Starred, (default: All)
Not starred]
fetchOnlyWithAttac boolean Retrieve only emails with False
hments (Has attachments
Attachments)
includeAttachments boolean If set to true, attachments False
(Include will also be retrieved
Attachments) along with the email

Returns:
Type:DetailedReceiveMessage
Description: Message details

844 | P a g e
 Gmail

845 | P a g e
 Gmail

Attachment
Summary:
Description: Attachment

Properties:
Name Type Summary
Name string Attachment name
Name
ContentBytes string(byte) Attachment content
Content
ContentType string Attachment content type
Content-Type
ContentId string Content ID

Size integer(int64) Attachment size

846 | P a g e
 Gmail

DetailedReceiveMessage
Summary:
Description: Message details

Properties:
Name Type Summary
From string(email) From
From
To string(email) To
To
Cc string(email) CC
CC
Bcc string(email) BCC
BCC
Subject string Subject
Subject
Body string Body
Body
Snippet string A short part of the
Snippet message text
LabelIds array of (string) Labels identifiers
Label IDs
HistoryId integer(int64) The ID of the last history
History ID record that modified this
message
DateTimeReceived string(date-time) Received date time
Received Date Time
EstimatedSize integer(int32) Estimated size in bytes of
Estimated Size the message

847 | P a g e
 Gmail

IsRead boolean True if the message is

Is Read? read; false otherwise
IsHtml boolean Is HTML
Is HTML
HasAttachments boolean Has attachments
Has Attachments
Attachments array of (Attachment) Attachments
Attachments
Id string The immutable ID of the
Message ID message
ThreadId string The ID of the thread the
Thread ID message belongs to

848 | P a g e
 Gmail

GmailLabel
Summary:
Description: Gmail label

Properties:
Name Type Summary
Id string Label ID

DisplayName string Display name

849 | P a g e
 Gmail

ReplyMessage
Summary:
Description: Message to reply to another message

Properties:
Name Type Summary
To string(email) Example:
To [email protected];
[email protected]
Cc string(email) Example:
CC [email protected];
[email protected]
Bcc string(email) Example:
BCC [email protected];
[email protected]
Subject string Email subject (if empty, the
Subject original subject used)
Body string Reply body
Body
ReplyAll boolean Reply to all recipients
Reply All (default: False)
IsHtml boolean Send the reply as HTML
Is HTML (default: True)
Importance string Select an importance
Importance (default: Normal) Values:
[Normal, Low, High]
Attachments array of (Attachment) Attachments to be sent
Attachments along with the reply

850 | P a g e
 Gmail

SendMessage
Summary:
Description: Message to send

Properties:
Name Type Summary
To string(email) Example:
To [email protected];
[email protected]
Cc string(email) Example:
CC [email protected];
[email protected]
Bcc string(email) Example:
BCC [email protected];
[email protected]
Subject string Email subject
Subject
Body string Email body
Body
IsHtml boolean Send the email as HTML
Is HTML (default: True)
Importance string Select an importance
Importance (default: Normal) Values:
[Normal, Low, High]
Attachments array of (Attachment) Attachments to be sent
Attachments along with the email

851 | P a g e
 Google Calendar

Google Calendar
Google Calendar lets you organize your schedule and share events with co-
workers and friends. With Google's free online calendar, it's easy to keep track
of your daily schedule.

Status: Preview Tier: Standard Version: 1.1

Actions:
Name Summary
ListCalendars () List calendars
ListEvents (string calendarId, List the events on a calendar
[Optional]string timeMin,
[Optional]string timeMax)
CreateEvent (string Create an event
calendarId, RequestEvent
newEvent)
GetEvent (string calendarId, Get an event
string eventId)
DeleteEvent (string Delete an event
calendarId, string eventId)
UpdateEvent (string Update an event
calendarId, string eventId,
PatchEvent updatedEvent)

Triggers:
Name Summary
OnNewEventInCalendar When an event is added to a calendar
(string calendar_id)

852 | P a g e
 Google Calendar

OnUpdatedEventInCalendar When an event is updated in a calendar

(string calendar_id)
OnDeletedEventInCalendar When an event is deleted from a calendar
(string calendar_id)
OnEventStarted (string When an event starts
calendar_id)

Objects:
Name Summary
CalendarEventList
CalendarList
CalendarListEntry
Object
PatchEvent
RequestEvent
ResponseEvent

Actions:
ListCalendars
Summary: List calendars
Description: Lists all calendars in the authenticated user's calendar list.

Syntax:
GoogleCalendar.ListCalendars ()

Returns:
Type:CalendarList
Description: A Google CalendarList Object

853 | P a g e
 Google Calendar

ListEvents
Summary: List the events on a calendar
Description: Lists the first page of arbitrarily ordered events on the selected calendar.

Syntax:
GoogleCalendar.ListEvents (string calendarId, [Optional]string
timeMin, [Optional]string timeMax)

Parameters:
Name Type Summary Required Related
Action
calendarId string Unique ID of the True ListCalendars
(Calendar calendar to fetch
ID) events from
timeMin string(date- Time format: False
time) yyyy-MM-
(Min Time) ddTHH:mm:ss.fffZ
(2016-07-
20T08:00:59.000Z)
timeMax string(date- Time format: False
time) yyyy-MM-
(Max time) ddTHH:mm:ss.fffZ
(2016-07-
20T09:00:59.000Z)

Returns:
Type:CalendarEventList
Description: A Google CalendarEventList Object

854 | P a g e
 Google Calendar

CreateEvent
Summary: Create an event
Description: Creates an event on a specific calendar

Syntax:
GoogleCalendar.CreateEvent (string calendarId, RequestEvent
newEvent)

Parameters:
Name Type Summary Required Related
Action
calendarId string Unique ID of True ListCalendars
(Calendar ID) the calendar to
fetch events
from
newEvent RequestEvent An event to True
upload to
Google
Calendar

Returns:
Type:ResponseEvent
Description: An event downloaded from Google Calendar

GetEvent
Summary: Get an event
Description: Get an event from a calendar

855 | P a g e
 Google Calendar

Syntax:
GoogleCalendar.GetEvent (string calendarId, string eventId)

Parameters:
Name Type Summary Required Related
Action
calendarId string Unique ID of True ListCalendars
(Calendar the calendar to
ID) fetch events
from
eventId string Unique ID of True
(Event ID) the event to get

Returns:
Type:ResponseEvent
Description: An event downloaded from Google Calendar

DeleteEvent
Summary: Delete an event
Description: Delete an event from a calendar

Syntax:
GoogleCalendar.DeleteEvent (string calendarId, string eventId)

Parameters:
Name Type Summary Required Related
Action

856 | P a g e
 Google Calendar

calendarId string Unique ID of True ListCalendars

(Calendar the calendar to
ID) fetch events
from
eventId string Unique ID of True
(Event ID) the event to
update

Returns:
Type:Object

UpdateEvent
Summary: Update an event
Description: Update an event on a calendar

Syntax:
GoogleCalendar.UpdateEvent (string calendarId, string eventId,
PatchEvent updatedEvent)

Parameters:
Name Type Summary Required Related
Action
calendarId string Unique ID of True ListCalendars
(Calendar the calendar to
ID) fetch events
from
eventId string Unique ID of True
(Event ID) the event to
get

857 | P a g e
 Google Calendar

updatedEvent PatchEvent Event changes True

to upload to
Google
Calendar

Returns:
Type:ResponseEvent
Description: An event downloaded from Google Calendar

Triggers:
Trigger OnNewEventInCalendar
Summary: When an event is added to a calendar
Description: Triggers a flow when a new event is added to a calendar

Syntax:
GoogleCalendar.OnNewEventInCalendar (string calendar_id)

Parameters:
Name Type Summary Required Related
Action
calendar_id string Unique ID of True ListCalendars
(Calendar the calendar to
ID) fetch events
from

Returns:
Type:CalendarEventList
Description: A Google CalendarEventList Object

858 | P a g e
 Google Calendar

Trigger OnUpdatedEventInCalendar
Summary: When an event is updated in a calendar
Description: Triggers a flow when an event is updated in a calendar

Syntax:
GoogleCalendar.OnUpdatedEventInCalendar (string calendar_id)

Parameters:
Name Type Summary Required Related
Action
calendar_id string Unique ID of True ListCalendars
(Calendar the calendar to
ID) fetch events
from

Returns:
Type:CalendarEventList
Description: A Google CalendarEventList Object

Trigger OnDeletedEventInCalendar
Summary: When an event is deleted from a calendar
Description: Triggers a flow when a new event is deleted from a calendar

Syntax:
GoogleCalendar.OnDeletedEventInCalendar (string calendar_id)

Parameters:

859 | P a g e
 Google Calendar

Name Type Summary Required Related

Action
calendar_id string Unique ID of True ListCalendars
(Calendar the calendar to
ID) fetch events
from

Returns:
Type:CalendarEventList
Description: A Google CalendarEventList Object

Trigger OnEventStarted
Summary: When an event starts
Description: Triggers a flow when an event starts

Syntax:
GoogleCalendar.OnEventStarted (string calendar_id)

Parameters:
Name Type Summary Required Related
Action
calendar_id string Unique ID of True ListCalendars
(Calendar the calendar to
ID) fetch events
from

Returns:
Type:CalendarEventList
Description: A Google CalendarEventList Object

860 | P a g e
Google Calendar

861 | P a g e
 Google Calendar

CalendarEventList
Summary:
Description: A Google CalendarEventList Object

Properties:
Name Type Summary
items array of (ResponseEvent) Events in the calendar
Items

862 | P a g e
 Google Calendar

CalendarList
Summary:
Description: A Google CalendarList Object

Properties:
Name Type Summary
items array of (CalendarListEntry) Calendars in the list
Items

863 | P a g e
 Google Calendar

CalendarListEntry
Summary:
Description: A Google CalendarListEntry Object

Properties:
Name Type Summary
id string Identifier of the calendar
Calendar ID
summary string Title of the calendar
Summary
description string Description of the
Description calendar
location string Geographic location of the
Location calendar as free-form text
timeZone string The time zone of the
Time Zone calendar

864 | P a g e
 Google Calendar

Object
Summary:
Description:

Properties:
Name Type Summary

865 | P a g e
 Google Calendar

PatchEvent
Summary:
Description: Event changes to upload to Google Calendar

Properties:
Name Type Summary
summary string A summary of the event
Title
start string(date-time) The (inclusive) start time
Start time of the event
end string(date-time) The (exclusive) end time of
End time the event
description string Description of the event
Description
location string Geographic location of the
Location event as free-form text
attendees string Enter a comma-separated
Attendees list of attendee emails
status string Status of the event.
Status Possible values are
"confirmed", "tentative",
or "cancelled Values:
[confirmed, tentative,
cancelled]

866 | P a g e
 Google Calendar

RequestEvent
Summary:
Description: An event to upload to Google Calendar

Properties:
Name Type Summary
summary string A summary of the event
Title
start string(date-time) The (inclusive) start time
Start time of the event
end string(date-time) The (exclusive) end time of
End time the event
description string Description of the event
Description
location string Geographic location of the
Location event as free-form text
attendees string Enter a comma-separated
Attendees list of attendee emails
status string Status of the event.
Status Possible values are
"confirmed", "tentative",
or "cancelled" Values:
[confirmed, tentative,
cancelled]

867 | P a g e
 Google Calendar

ResponseEvent
Summary:
Description: An event downloaded from Google Calendar

Properties:
Name Type Summary
summary string A summary of the event
Title
start string(date-time) The (inclusive) start time
Start time of the event
end string(date-time) The (exclusive) end time
End time of the event
description string Description of the event
Description
location string Geographic location of
Location the event as free-form
text
status string Status of the event.
Status Possible values are
"confirmed", "tentative",
or "cancelled"
htmlLink string Unique ID of the list
HTML link
id string Opaque identifier of the
Event ID event
attendees string The event's attendees
Attendees
creator string The creator of the event
Creator

868 | P a g e
 Google Calendar

organizer string The organizer of the

Organizer event
created string(date-time) Creation time of the
Created event
updated string(date-time) Last modification time of
Updated the event
endTimeUnspecified boolean Whether the end time is
End Time Unspecified actually unspecified. An
end time is still
provided for compatibility
reasons, even if this
attribute is set to True.

869 | P a g e
 Google Contacts

Google Contacts
Google Contacts is an online address book, integrated across your Google
products and more.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
ListContacts () Get my contacts
CreateContact Create a contact
(CreateContactParameterBody
body)
ListGroups () Get my groups

Triggers:
Name Summary
OnContactUpdated () When a contact changes

Objects:
Name Summary
CreateContactParameterBody
CreateContactResponse
Entry
ListContactsResponse
ListGroupsResponseItem
OnContactUpdatedResponse

870 | P a g e
 Google Contacts

Actions:
ListContacts
Summary: Get my contacts
Description: Get my contacts.

Syntax:
GoogleContacts.ListContacts ()

Returns:
Type:ListContactsResponse

CreateContact
Summary: Create a contact
Description: Create a contact within Google Contacts

Syntax:
GoogleContacts.CreateContact (CreateContactParameterBody body)

Parameters:
Name Type Summary Required Related
Action
body CreateContactParameterBody True

Returns:
Type:CreateContactResponse

ListGroups
Summary: Get my groups
871 | P a g e
 Google Contacts

Description:

Syntax:
GoogleContacts.ListGroups ()

Returns:
Type:array of (ListGroupsResponseItem)

Triggers:
Trigger OnContactUpdated
Summary: When a contact changes
Description: When a contact changes in Google Contacts.

Syntax:
GoogleContacts.OnContactUpdated ()

Returns:
Type:OnContactUpdatedResponse

872 | P a g e
 Google Contacts

CreateContactParameterBody
Summary:
Description:

Properties:
Name Type Summary
displayName string Display name for the
Display Name contact.
workEmail string
Work Email Address
group string Group to add the contact
Group to.
company string
Company
workPhoneNumber string
Work Phone Number
mobilePhoneNumber string
Mobile Phone Number
homeEmail string Home Email address for
Home Email Address the contact.
otherEmail string
Other Email Address
nickName string
Nickname
homeAddress string
Home Address
workAddress string
Work Address
otherAddress string

873 | P a g e
 Google Contacts

Other Address
jobTitle string
Job Title
homePhoneNumber string
Home Phone Number
otherPhoneNumber string
Other Phone Number
notes string
Notes

874 | P a g e
 Google Contacts

CreateContactResponse
Summary:
Description:

Properties:
Name Type Summary
entry Entry

875 | P a g e
 Google Contacts

Entry
Summary:
Description:

Properties:
Name Type Summary
id Id

updated Updated

title Title

gd$name Gd$name

gContact$nickname GContact$nickname

gd$organization array of
(Gd$organizationItem)

workEmail string The work email address

Work Email of the contact.
homeEmail string The home address of
Home Email the contact.
otherEmail string The other address of the
Other Email contact.
workPhoneNumber string The work phone
Work Phone Number number of the contact.
homePhoneNumber string The home phone
Home Phone Number number of the contact.

876 | P a g e
 Google Contacts

otherPhoneNumber string The other phone

Other Phone Number number of the contact.
mobilePhoneNumber string The mobile phone
Mobile Phone Number number of the contact.
workAddress string The work address of the
Work Address contact.
homeAddress string The home address of
Home Address the contact.
otherAddress string The other address of the
Other Address contact.

Id
Summary:
Description:

Properties:
Name Type Summary
$t string The id of the contact.
Id

Updated
Summary:
Description:

Properties:
Name Type Summary
$t string(date-time) The datetime the contact
Updated DateTime was last updated, in yyyy-
MM-ddTHH:mm:ss.fffZ

877 | P a g e
 Google Contacts

(2016-07-
20T08:00:59.000Z).

Title
Summary:
Description:

Properties:
Name Type Summary
$t string The job title of the
Title contact.

Gd$name
Summary:
Description:

Properties:
Name Type Summary
gd$fullName Gd$fullName

gd$givenName Gd$givenName

gd$familyName Gd$familyName

Gd$fullName
Summary:
Description:

878 | P a g e
 Google Contacts

Properties:
Name Type Summary
$t string The full name of the
Full Name contact.

Gd$givenName
Summary:
Description:

Properties:
Name Type Summary
$t string The given name of the
Given Name contact.

Gd$familyName
Summary:
Description:

Properties:
Name Type Summary
$t string The family name of the
Last Name contact.

GContact$nickname
Summary:
Description:

Properties:

879 | P a g e
 Google Contacts

Name Type Summary

$t string The nickname of the
Nickname contact.

Gd$organizationItem
Summary: Organization
Description:

Properties:
Name Type Summary
gd$orgName Gd$orgName

gd$orgTitle Gd$orgTitle

Gd$orgName
Summary:
Description:

Properties:
Name Type Summary
$t string The origanization name.
Name

Gd$orgTitle
Summary:
Description:

Properties:

880 | P a g e
 Google Contacts

Name Type Summary

$t string The organization title.
Title

881 | P a g e
 Google Contacts

ListContactsResponse
Summary:
Description:

Properties:
Name Type Summary
feed Feed

Feed
Summary:
Description:

Properties:
Name Type Summary
entry array of (Entry)
Contact

882 | P a g e
 Google Contacts

ListGroupsResponseItem
Summary:
Description:

Properties:
Name Type Summary
id string

title string

883 | P a g e
 Google Contacts

OnContactUpdatedResponse
Summary:
Description:

Properties:
Name Type Summary
feed Feed

Feed
Summary:
Description:

Properties:
Name Type Summary
entry array of (Entry)

884 | P a g e
 Google Tasks

Google Tasks
Google Tasks is a very simple task list. Works inside Gmail, Android, and
Calendar seamlessly.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
ListTaskLists () List task lists
CreateTaskList (TaskListCreate Create a task list
list)
ListTasks (string taskListId) Lists the tasks for a task list
CraeteTask (string taskListId, Create a task in a task list
TaskCreate task)
ListTask (string taskListId, Get a task from a task list
string taskId)

Triggers:
Name Summary
OnNewTaskList () When a new task list is created
OnNewTaskInList (string When a task is added to a task list
taskListId)
OnCompletedTaskInList When a task is completed in a task list
(string taskListId)
OnDueTaskInList (string When a task is due in a task list
taskListId)

885 | P a g e
 Google Tasks

Objects:
Name Summary
Task
TaskCreate
TaskList
TaskListCreate
TaskListEntry
TaskListList

Actions:
ListTaskLists
Summary: List task lists
Description: Lists all task lists

Syntax:
GoogleTasks.ListTaskLists ()

Returns:
Type:TaskListList
Description: A list of task lists

CreateTaskList
Summary: Create a task list
Description: Creates a new task list

Syntax:
GoogleTasks.CreateTaskList (TaskListCreate list)

886 | P a g e
 Google Tasks

Parameters:
Name Type Summary Required Related
Action
list TaskListCreate Object used to True
create a task list

Returns:
Type:TaskListEntry
Description: A task list

ListTasks
Summary: Lists the tasks for a task list
Description: Lists the tasks for a task list

Syntax:
GoogleTasks.ListTasks (string taskListId)

Parameters:
Name Type Summary Required Related
Action
taskListId string The id of the True ListTaskLists
(Task List task list
ID)

Returns:
Type:TaskList
Description: A list of tasks

887 | P a g e
 Google Tasks

CraeteTask
Summary: Create a task in a task list
Description: Create a task in a task list

Syntax:
GoogleTasks.CraeteTask (string taskListId, TaskCreate task)

Parameters:
Name Type Summary Required Related
Action
taskListId string The id of the True ListTaskLists
(Task List task list
ID)
task TaskCreate Represents the True
values used to
create a task

Returns:
Type:Task
Description: A task

ListTask
Summary: Get a task from a task list
Description: Get a task from a task list

Syntax:
GoogleTasks.ListTask (string taskListId, string taskId)

Parameters:

888 | P a g e
 Google Tasks

Name Type Summary Required Related

Action
taskListId string The id of the True ListTaskLists
(Task List task list
ID)
taskId string The id of the True ListTasks
(Task ID) task

Returns:
Type:Task
Description: A task

Triggers:
Trigger OnNewTaskList
Summary: When a new task list is created
Description: Trigger for when a new task list is created

Syntax:
GoogleTasks.OnNewTaskList ()

Returns:
Type:TaskListList
Description: A list of task lists

Trigger OnNewTaskInList
Summary: When a task is added to a task list
Description: When a task is added to a task list

Syntax:

889 | P a g e
 Google Tasks

GoogleTasks.OnNewTaskInList (string taskListId)

Parameters:
Name Type Summary Required Related
Action
taskListId string The id of the True ListTaskLists
(Task List task list
ID)

Returns:
Type:TaskList
Description: A list of tasks

Trigger OnCompletedTaskInList
Summary: When a task is completed in a task list
Description: When a task is completed in a task list

Syntax:
GoogleTasks.OnCompletedTaskInList (string taskListId)

Parameters:
Name Type Summary Required Related
Action
taskListId string The id of the True ListTaskLists
(Task List task list
ID)

Returns:
Type:TaskList

890 | P a g e
 Google Tasks

Description: A list of tasks

Trigger OnDueTaskInList
Summary: When a task is due in a task list
Description: When a task is due in a task list

Syntax:
GoogleTasks.OnDueTaskInList (string taskListId)

Parameters:
Name Type Summary Required Related
Action
taskListId string The id of the True ListTaskLists
(Task List task list
ID)

Returns:
Type:TaskList
Description: A list of tasks

891 | P a g e
 Google Tasks

Task
Summary:
Description: A task

Properties:
Name Type Summary
id string Identifier of the task
Task Id
title string Title of the task
Title
updated string(date-time) The last time the task was
Updated updated
selfLink string A link to this task
HTML Link
parent string Parent of the task
Parent
position string Position of the task
Position
notes string Notes for the task
Notes
status string Status of the task
Status
due string(date-time) Time the task is due
Due
completed string(date-time) Time the task was
Completed completed

892 | P a g e
 Google Tasks

TaskCreate
Summary:
Description: Represents the values used to create a task

Properties:
Name Type Summary
title string Title of the task
Title
notes string Notes for the task
Notes
due string(date-time) Date the task is due
Due

893 | P a g e
 Google Tasks

TaskList
Summary:
Description: A list of tasks

Properties:
Name Type Summary
items array of (Task) Tasks in the list
Items

894 | P a g e
 Google Tasks

TaskListCreate
Summary:
Description: Object used to create a task list

Properties:
Name Type Summary
title string Title of the task list
Title

895 | P a g e
 Google Tasks

TaskListEntry
Summary:
Description: A task list

Properties:
Name Type Summary
id string Identifier of the task list
Task List ID
title string Title of the task list
Title
selfLink string A link to this task list
HTML Link
updated string(date-time) Time the task list was last
Updated Time updated

896 | P a g e
 Google Tasks

TaskListList
Summary:
Description: A list of task lists

Properties:
Name Type Summary
items array of (TaskListEntry) Task lists in the lists
Items

897 | P a g e
 GoToMeeting

GoToMeeting
GoToMeeting is an online meeting tool. You can schedule your own meetings
or watch for the ones you are invited to.

Status: Preview Tier: Premium Version: 1.0.0

Actions:
Name Summary
GetUpcomingMeetings () List upcoming meetings
CreateMeeting Create a meeting
(CreateMeetingParameterNewMeeting
newMeeting)
GetMeeting (string meetingId) Get a meeting
UpdateMeeting (string meetingId, Update a meeting
UpdateMeetingParameterMeeting
meeting)
GetMeetingAttendees (string Get meeting attendees
meetingId)

Triggers:
Name Summary
OnNewMeeting () When a meeting is created
OnMeetingComplete () When a meeting ends

Objects:
Name Summary
Attendee

898 | P a g e
 GoToMeeting

CreateMeetingParameterNewMeeting
GetUpcomingMeetingsResponseItem
Meeting
NewMeetingResponse
UpdateMeetingParameterMeeting

Actions:
GetUpcomingMeetings
Summary: List upcoming meetings
Description: Returns upcoming meetings for the authenticated organizer.

Syntax:
GoToMeeting.GetUpcomingMeetings ()

Returns:
Type:array of (GetUpcomingMeetingsResponseItem)

CreateMeeting
Summary: Create a meeting
Description: Create a new meeting based on the parameters specified.

Syntax:
GoToMeeting.CreateMeeting (CreateMeetingParameterNewMeeting
newMeeting)

Parameters:

899 | P a g e
 GoToMeeting

Name Type Summar Require Relate

y d d
Action
newMeetin CreateMeetingParameterNewMeetin Model True
g g used to
create a
meeting

Returns:
Type:NewMeetingResponse

GetMeeting
Summary: Get a meeting
Description: Returns the meeting details for the specified meeting.

Syntax:
GoToMeeting.GetMeeting (string meetingId)

Parameters:
Name Type Summary Required Related Action
meetingId string Select or True GetUpcomingMeetings
(Meeting enter a
Id) meeting Id

Returns:
Type:Meeting
Description: Represents a meeting

900 | P a g e
 GoToMeeting

UpdateMeeting
Summary: Update a meeting
Description: Updates an existing meeting specified by meetingId.

Syntax:
GoToMeeting.UpdateMeeting (string meetingId,
UpdateMeetingParameterMeeting meeting)

Parameters:
Name Type Summa Require Related Action
ry d
meetingI string Select True GetUpcomingMeeti
d (Meeting Id) or enter ngs
a
meeting
Id
meeting UpdateMeetingParameterMe Model True
eting used to
update
a
meeting

Returns:

GetMeetingAttendees
Summary: Get meeting attendees
Description: Returns a list of attendees for a meeting with the given ID.

Syntax:

901 | P a g e
 GoToMeeting

GoToMeeting.GetMeetingAttendees (string meetingId)

Parameters:
Name Type Summary Required Related
Action
meetingId string True
(Meeting
Id)

Returns:
Type:array of (Attendee)

Triggers:
Trigger OnNewMeeting
Summary: When a meeting is created
Description: Triggers a flow when a new meeting is created

Syntax:
GoToMeeting.OnNewMeeting ()

Returns:
Type:array of (GetUpcomingMeetingsResponseItem)

Trigger OnMeetingComplete
Summary: When a meeting ends
Description: Triggers when a meeting ends.

Syntax:

902 | P a g e
 GoToMeeting

GoToMeeting.OnMeetingComplete ()

Returns:
Type:array of (GetUpcomingMeetingsResponseItem)

903 | P a g e
 GoToMeeting

Attendee
Summary:
Description:

Properties:
Name Type Summary
groupName string The group the attendee
Group name belongs to.
attendeeName string The name of the
Name attendee.
joinTime string(date-time) The time the attendee
Join time joined the meeting.
leaveTime string(date-time) The time the attendee left
Leave time the meeting.
attendeeEmail string The email address of the
Attendee email attendee.

904 | P a g e
 GoToMeeting

CreateMeetingParameterNewMeeting
Summary:
Description: Model used to create a meeting

Properties:
Name Type Summary
subject string
Subject
starttime string(date-time) Time format: yyyy-MM-
Start time ddTHH:mm:ss.fffZ (2016-
07-20T08:00:59.000Z)
endtime string(date-time) Time format: yyyy-MM-
End time ddTHH:mm:ss.fffZ (2016-
07-20T08:00:59.000Z)
passwordrequired boolean Indicates whether the
Requires password meeting requires a
password
conferencecallinfo string Conference call type
Conference call info (PSTN, Free, Hybrid,
Private, VoIP) or a custom
value Values: [PSTN, Free,
Hybrid, Private, VoIP]
meetingtype string Values: [immediate,
Meeting type recurring, scheduled]

905 | P a g e
 GoToMeeting

GetUpcomingMeetingsResponseItem
Summary:
Description: Represents a meeting

Properties:
Name Type Summary
subject string The subject of the
Subject meeting.
startTime string(date-time) The start time of the
Start time meeting, in yyyy-MM-
ddTHH:mm:ss.fffZ (2016-
07-20T08:00:59.000Z).
endTime string(date-time) The end time of the
End time meeting, in yyyy-MM-
ddTHH:mm:ss.fffZ (2016-
07-20T08:00:59.000Z).
firstName string The first name of the
Organizer first name meeting organizer.
lastName string The last name of the
Organizer last name meeting organizer.
email string The email address of the
Organizer email meeting organizer.
conferenceCallInfo string Audio options for the
Conference call info meeting.
passwordRequired string Indicates whether the
Requires password meeting requires a
password.
status string
Status

906 | P a g e
 GoToMeeting

locale string Indicates the location and

Location code language of the meeting.
meetingId string The id of the meeting.
Meeting Id
meetingType string The meeting type, such as
Meeting type immediate, recurring or
scheduled.

907 | P a g e
 GoToMeeting

Meeting
Summary:
Description: Represents a meeting

Properties:
Name Type Summary
subject string The subject of the
Subject meeting.
startTime string(date-time) The start time of the
Start time meeting, in yyyy-MM-
ddTHH:mm:ss.fffZ (2016-
07-20T08:00:59.000Z).
endTime string(date-time) The end time of the
End time meeting, in yyyy-MM-
ddTHH:mm:ss.fffZ (2016-
07-20T08:00:59.000Z).
firstName string The first name of the
Organizer first name meeting organizer.
lastName string The last name of the
Organizer last name meeting organizer.
email string The email address of the
Organizer email meeting organizer.
conferenceCallInfo string Audio options for the
Conference call info meeting.
passwordRequired string Indicates whether the
Requires password meeting requires a
password.
status string
Status

908 | P a g e
 GoToMeeting

locale string Indicates the location and

Location code language of the meeting.
meetingId string The id of the meeting.
Meeting Id
meetingType string The meeting type, such as
Meeting type immediate, recurring or
scheduled.

909 | P a g e
 GoToMeeting

NewMeetingResponse
Summary:
Description:

Properties:
Name Type Summary
joinURL string A URL that can be used to
Join URL join the meeting
meetingid integer(int32) The id of the meeting.
Meeting Id
maxParticipants integer(int32) The maximum number of
Max participants participants allowed in
the meeting.
conferenceCallInfo string Audio options for the
Conference call info meeting.

910 | P a g e
 GoToMeeting

UpdateMeetingParameterMeeting
Summary:
Description: Model used to update a meeting

Properties:
Name Type Summary
subject string
Subject
starttime string(date-time) Time format: yyyy-MM-
Start time ddTHH:mm:ss.fffZ (2016-
07-20T08:00:59.000Z)
endtime string(date-time) Time format: yyyy-MM-
End time ddTHH:mm:ss.fffZ (2016-
07-20T08:00:59.000Z)
passwordrequired boolean Indicates whether the
Requires password meeting requires a
password
conferencecallinfo string Conference call type
Conference call info (PSTN, Free, Hybrid,
Private, VoIP) or a custom
value Values: [PSTN, Free,
Hybrid, Private, VoIP]
meetingtype string Values: [immediate,
Meeting type recurring, scheduled]

911 | P a g e
 GoToTraining

GoToTraining
Citrix GoToTraining enables you to manage a stable and high-performance
online training environment.

Status: Preview Tier: Premium Version: 1.0.0

Actions:
Name Summary
ListTrainings () List trainings
GetTraining (string trainingid) Get training
ListRegistrations (string List registrants
trainingid)
AddRegistrant (string Add registrant
trainingid,
AddRegistrantParameterBody
body)
GetRegistrant (string Get Registrant
trainingid, string
registrantKey)

Triggers:
Name Summary
OnNewTraining () When a training is created
OnNewRegistration (string When a registrant is added
trainingid)

Objects:
Name Summary

912 | P a g e
 GoToTraining

AddRegistrantParameterBody
AddRegistrantResponse
Registrant
Training

Actions:
ListTrainings
Summary: List trainings
Description: Retrieves a list of trainings organized by the authenticated user.

Syntax:
GoToTraining.ListTrainings ()

Returns:
Type:array of (Training)

GetTraining
Summary: Get training
Description: Retrieves all information about a scheduled training.

Syntax:
GoToTraining.GetTraining (string trainingid)

Parameters:
Name Type Summary Required Related
Action
trainingid string Training True ListTrainings

913 | P a g e
 GoToTraining

(Training
Id)

Returns:
Type:Training

ListRegistrations
Summary: List registrants
Description: Retrieves details of all registrants for a specific training.

Syntax:
GoToTraining.ListRegistrations (string trainingid)

Parameters:
Name Type Summary Required Related
Action
trainingid string Training True ListTrainings
(Training
Id)

Returns:
Type:array of (Registrant)

AddRegistrant
Summary: Add registrant
Description: Registers one person, identified by a unique email address, for a training.

Syntax:

914 | P a g e
 GoToTraining

GoToTraining.AddRegistrant (string trainingid,

AddRegistrantParameterBody body)

Parameters:
Name Type Summary Required Related
Action
trainingid string Training True ListTrainings
(Training Id)
body AddRegistrantParameterBody True

Returns:
Type:AddRegistrantResponse

GetRegistrant
Summary: Get Registrant
Description: Retrieves details of a specific registrant in a training.

Syntax:
GoToTraining.GetRegistrant (string trainingid, string
registrantKey)

Parameters:
Name Type Summary Required Related
Action
trainingid string Training True ListTrainings
(Training
Id)
registrantKey string Registrant key True

915 | P a g e
 GoToTraining

(Registrant
key)

Returns:
Type:Registrant

Triggers:
Trigger OnNewTraining
Summary: When a training is created
Description: Triggers when a new training is created.

Syntax:
GoToTraining.OnNewTraining ()

Returns:
Type:array of (Training)

Trigger OnNewRegistration
Summary: When a registrant is added
Description: Triggers when a registrant is added to a training.

Syntax:
GoToTraining.OnNewRegistration (string trainingid)

Parameters:
Name Type Summary Required Related
Action
trainingid string Training True ListTrainings

916 | P a g e
 GoToTraining

(Training
Id)

Returns:
Type:array of (Registrant)

917 | P a g e
 GoToTraining

AddRegistrantParameterBody
Summary:
Description:

Properties:
Name Type Summary
email string Registrant email
Registrant email
givenName string First name
First name
surname string Last name
Last name

918 | P a g e
 GoToTraining

AddRegistrantResponse
Summary:
Description:

Properties:
Name Type Summary
joinUrl string Url link to join the
Join Url meeting.
confirmationUrl string Url link for rsvp.
Confirmation Url
registrantKey string Unique identifier of the
Registrant Key registrant.

919 | P a g e
 GoToTraining

Registrant
Summary:
Description:

Properties:
Name Type Summary
email string Registrant's email.
Email
givenName string Registrant's first name.
First name
surname string Registrant's last name.
Last name
status string Registrant's rsvp status.
Status
registrationDate string(date-time) YYYY-MM-DDThh:mm:ssZ
Registration date-time (UTC format)
joinUrl string Link to use by the
Join Url registrant to join a
training.
confirmationUrl string Link to use by the
Confirmation Url registrant to rsvp for a
training.
registrantKey string Unique key of the
Registrant Key registrant.

920 | P a g e
 GoToTraining

Training
Summary:
Description:

Properties:
Name Type Summary
trainingId string Unique identifier of the
Training Id training.
name string Subject of the training.
Title
timeZone string Where the training will
Time Zone take place.
times array of (TimesItem)

organizers array of (OrganizersItem)

registrationSettings RegistrationSettings
Registration Settings
trainingKey string Unique key of the
Training Key training.

TimesItem
Summary:
Description:

Properties:
Name Type Summary
startDate string(date-time) YYYY-MM-DDThh:mm:ssZ
Start date-time (UTC format)

921 | P a g e
 GoToTraining

endDate string(date-time) YYYY-MM-DDThh:mm:ssZ

End date-time (UTC format)

OrganizersItem
Summary:
Description:

Properties:
Name Type Summary
givenName string Organizer's first name.
First Name
surname string Organizer's last name.
Last Name
email string Organizer's email.
Email
organizerKey string Unique identifier of the
Organizer key organizer

RegistrationSettings
Summary: Registration Settings
Description:

Properties:
Name Type Summary
disableConfirmationEmail boolean
Disable Confirmation
Email
disableWebRegistration boolean
Disable Web Registration

922 | P a g e
GoToTraining

923 | P a g e
 GoToWebinar

GoToWebinar
Citrix GoToWebinar enables you to manage a stable and high-performance
online webinar environment.

Status: Preview Tier: Premium Version: 1.0.0

Actions:
Name Summary
GetWebinar (string Get webinar
webinarKey)
ListRegistrations (string List registrants
webinarKey)
AddRegistrant (string Add registrant
webinarKey, NewRegistrant
body)
GetRegistrant (string Get Registrant
webinarKey, string
registrantKey)
ListWebinars () List Webinars

Triggers:
Name Summary
OnNewWebinar () When a webinar is created
OnNewRegistration (string When a registrant is added
webinarKey)

Objects:
Name Summary

924 | P a g e
 GoToWebinar

NewRegistrant
Registrant
RegistrantSummary
RegistrationResult
Webinar
WebinarSummary

Actions:
GetWebinar
Summary: Get webinar
Description: Retrieves all information about a scheduled webinar.

Syntax:
GoToWebinar.GetWebinar (string webinarKey)

Parameters:
Name Type Summary Required Related
Action
webinarKey string The key of the True ListWebinars
(Webinar Webinar.
key)

Returns:
Type:Webinar

ListRegistrations
Summary: List registrants
Description: Retrieves a list of all registrants for a specific webinar.

925 | P a g e
 GoToWebinar

Syntax:
GoToWebinar.ListRegistrations (string webinarKey)

Parameters:
Name Type Summary Required Related
Action
webinarKey string The key of the True ListWebinars
(Webinar Webinar.
key)

Returns:
Type:array of (RegistrantSummary)

AddRegistrant
Summary: Add registrant
Description: Registers one person, identified by a unique email address, for a webinar.

Syntax:
GoToWebinar.AddRegistrant (string webinarKey, NewRegistrant
body)

Parameters:
Name Type Summary Required Related
Action
webinarKey string The key of the True ListWebinars
(Webinar key) Webinar.
body NewRegistrant True

926 | P a g e
 GoToWebinar

Returns:
Type:RegistrationResult

GetRegistrant
Summary: Get Registrant
Description: Retrieves details of a specific registrant in a webinar.

Syntax:
GoToWebinar.GetRegistrant (string webinarKey, string
registrantKey)

Parameters:
Name Type Summary Required Related
Action
webinarKey string The key of the True ListWebinars
(Webinar Webinar.
key)
registrantKey string They key of the True
(Registrant registrant.
key)

Returns:
Type:Registrant

ListWebinars
Summary: List Webinars
Description: Retrieves a list of all webinars for the authenticated user.

Syntax:

927 | P a g e
 GoToWebinar

GoToWebinar.ListWebinars ()

Returns:
Type:array of (WebinarSummary)

Triggers:
Trigger OnNewWebinar
Summary: When a webinar is created
Description: Triggers when a new webinar is created.

Syntax:
GoToWebinar.OnNewWebinar ()

Returns:
Type:array of (WebinarSummary)

Trigger OnNewRegistration
Summary: When a registrant is added
Description: Triggers when a new registrant is added to a webinar.

Syntax:
GoToWebinar.OnNewRegistration (string webinarKey)

Parameters:
Name Type Summary Required Related
Action
webinarKey string The key of the True ListWebinars
Webinar.

928 | P a g e
 GoToWebinar

(Webinar
key)

Returns:
Type:array of (RegistrantSummary)

929 | P a g e
 GoToWebinar

NewRegistrant
Summary:
Description:

Properties:
Name Type Summary
email string Registrant's email address.
Email
firstName string Registrant's first name.
First name
lastName string Registrant's last name.
Last name

930 | P a g e
 GoToWebinar

Registrant
Summary:
Description:

Properties:
Name Type Summary
firstName string Registrant's first name.
First name
lastName string Registrant's last name.
Last name
unsubscribed boolean True if the registrant
Unsubscribed opted-out from receiving
other emails from the
webinar's organizer.
registrationDate string(date-time) YYYY-MM-DDThh:mm:ssZ
Registration date-time (UTC format)
timeZone string Where the webinar will
Time zone take place.
responses array of (ResponsesItem)

joinUrl string Url the registrant will use

Join Url to join the webinar.
type string Sequence or one session.
Type
registrantKey string Unique key of the
Registrant Key registrant.
email string Registrant's email
Email address.

931 | P a g e
 GoToWebinar

status string Approved, denied or

Status waiting.

ResponsesItem
Summary:
Description:

Properties:
Name Type Summary
question string Custom question for
Registration question registering.
answer string Custom answer for
Registration answer registring.

932 | P a g e
 GoToWebinar

RegistrantSummary
Summary:
Description:

Properties:
Name Type Summary
firstName string Registrant's first name.
First name
lastName string Registrant's last name.
Last name
registrationDate string(date-time) YYYY-MM-DDThh:mm:ssZ
Registration date-time (UTC format)
timeZone string Where the webinar will
Time zone take place.
joinUrl string Url the registrant will use
Join Url to join the webinar.
registrantKey string Unique key of the
Registrant Key registrant.
email string Registrant's email address.
Email
status string Approved, denied or
Status waiting.

933 | P a g e
 GoToWebinar

RegistrationResult
Summary:
Description:

Properties:
Name Type Summary
registrantKey string Unique key of the
Registrant Key registrant.
joinUrl string Url the registrant will use
Join Url to join the webinar.
status string Approved, denied or
Status waiting.
description string Registrant's description.
Description

934 | P a g e
 GoToWebinar

Webinar
Summary:
Description:

Properties:
Name Type Summary
webinarKey string Unique key of the
Webinar key webinar.
numberOfRegistrationLinkClicks integer(int32) Number of registration
Registration click count link clicks.
times array of (TimesItem)

numberOfRegistrants integer(int32) Number of registrants

Registrant count at the webinar.
webinarID string 9-digit unique id of the
Webinar Id webinar.
subject string Webinar's subject.
Subject
description string Webinar's short
Description description.
timeZone string Where the webinar is
Time Zone taking place.
inSession boolean True is webinar is
In session currently in progress.
organizerKey integer(int32) Unique key of the
Organizer Key webinar organizer.
registrationUrl string Url the invitees can use
Registration Url to register.

935 | P a g e
 GoToWebinar

numberOfOpenedInvitations integer(int32) Number of recipients

Number of opened who opened the
invitations invitation email to
register for the
webinar.

TimesItem
Summary:
Description:

Properties:
Name Type Summary
startTime string(date-time) YYYY-MM-DDThh:mm:ssZ
Start date-time (UTC format)
endTime string(date-time) YYYY-MM-DDThh:mm:ssZ
End date-time (UTC format)

936 | P a g e
 GoToWebinar

WebinarSummary
Summary:
Description:

Properties:
Name Type Summary
webinarKey string Unique key of the
Webinar key webinar.
times array of (TimesItem)

numberOfRegistrants integer(int32) Number of registrants at

Registrant count the webinar.
webinarID string 9-digit unique id of the
Webinar Id webinar.
subject string Webinar's subject.
Subject
description string Webinar's short
Description description.
timeZone string Where the webinar is
Time Zone taking place.
inSession boolean True is webinar is
In Session currently in progress.
organizerKey integer(int32) Unique key of the
Organizer Key webinar organizer.
registrationUrl string Url the invitees can use
Registration Url to register.

TimesItem
Summary:

937 | P a g e
 GoToWebinar

Description:

Properties:
Name Type Summary
startTime string(date-time) YYYY-MM-DDThh:mm:ssZ
Start date-time (UTC format)
endTime string(date-time) YYYY-MM-DDThh:mm:ssZ
End date-time (UTC format)

938 | P a g e
 Harvest

Harvest
Harvest is a simple tool to help track the time spent by your team on each
project and task.

Status: Preview Tier: Premium Version: 1.0.0

Actions:
Name Summary
ListAllContacts () List all contacts
AddNewContact Add new contact
(AddNewContactParameterBody
body)
ListAllClients () List all clients
AddNewClient Add new client
(AddNewClientParameterBody
body)
ListAllUsers () List all users
CreateUser Add new user
(CreateUserParameterBody
body)
UpdateTimeEntry (string Update time entry
DAY_ENTRY_ID,
UpdateTimeEntryParameterBody
body)
CreateTimeEntry Create time entry
(CreateTimeEntryParameterBody
body)
ListProjects () List projects

939 | P a g e
 Harvest

DeleteTimeEntry (string Delete time entry

DAY_ENTRY_ID)
AddUserToProject (string Add user to a project
project_id,
AddUserToProjectParameterBody
body)
GetTimeEntry (string Get time entry by id
DAY_ENTRY_ID)
ListTasks () List tasks
GetUser (string USERID) Get user info

Triggers:
Name Summary
TrigNewUser () When a user is added
TrigNewClient () When a client is added
TrigNewContact () When a contact is added
TrigNewProject () When a project is created
TrigNewTimeEntryToday When a time entry is created for the current day
([Optional]string of_user)
TrigNewTimeEntry (string When a time entry is created for date
date,
[advanced][Optional]string
of_user)

Objects:
Name Summary
AddNewClientParameterBody
AddNewContactParameterBody

940 | P a g e
 Harvest

AddUserToProjectParameterBody
CreateTimeEntryParameterBody
CreateUserParameterBody
GetTimeEntriesForDay_Response
GetUserByID_Response
ListTasksResponseItem
TrigNewClientResponseItem
TrigNewContactResponseItem
TrigNewProjectResponseItem
UpdateTimeEntryParameterBody
UpdateTimeEntry_Response

Actions:
ListAllContacts
Summary: List all contacts
Description: Retrieves a list of all contacts for the authenticated user.

Syntax:
Harvest.ListAllContacts ()

Returns:
Type:array of (TrigNewContactResponseItem)

AddNewContact
Summary: Add new contact
Description: Create a new contact.

Syntax:

941 | P a g e
 Harvest

Harvest.AddNewContact (AddNewContactParameterBody body)

Parameters:
Name Type Summary Required Related
Action
body AddNewContactParameterBody True

Returns:

ListAllClients
Summary: List all clients
Description: Retrieves a list of all clients for the authenticated account.

Syntax:
Harvest.ListAllClients ()

Returns:
Type:array of (TrigNewClientResponseItem)

AddNewClient
Summary: Add new client
Description: Create a new client.

Syntax:
Harvest.AddNewClient (AddNewClientParameterBody body)

Parameters:

942 | P a g e
 Harvest

Name Type Summary Required Related

Action
body AddNewClientParameterBody True

Returns:

ListAllUsers
Summary: List all users
Description: Retrieves a list of all users of the authenticated account.

Syntax:
Harvest.ListAllUsers ()

Returns:
Type:array of (GetUserByID_Response)

CreateUser
Summary: Add new user
Description: Create a new user.

Syntax:
Harvest.CreateUser (CreateUserParameterBody body)

Parameters:
Name Type Summary Required Related
Action
body CreateUserParameterBody True

943 | P a g e
 Harvest

Returns:

UpdateTimeEntry
Summary: Update time entry
Description: Update an existing time entry.

Syntax:
Harvest.UpdateTimeEntry (string DAY_ENTRY_ID,
UpdateTimeEntryParameterBody body)

Parameters:
Name Type Summary Required Related
Action
DAY_ENTRY_ID string True
(Time Entry Id)
body UpdateTimeEntryParameterBody True

Returns:
Type:UpdateTimeEntry_Response

CreateTimeEntry
Summary: Create time entry
Description: Create a new time entry.

Syntax:
Harvest.CreateTimeEntry (CreateTimeEntryParameterBody body)

944 | P a g e
 Harvest

Parameters:
Name Type Summary Required Related
Action
body CreateTimeEntryParameterBody True

Returns:
Type:UpdateTimeEntry_Response

ListProjects
Summary: List projects
Description: Lists all projects for the current user.

Syntax:
Harvest.ListProjects ()

Returns:
Type:array of (TrigNewProjectResponseItem)

DeleteTimeEntry
Summary: Delete time entry
Description: Delete an existing time entry.

Syntax:
Harvest.DeleteTimeEntry (string DAY_ENTRY_ID)

Parameters:

945 | P a g e
 Harvest

Name Type Summary Required Related

Action
DAY_ENTRY_ID string True
(Time Entry
Id)

Returns:

AddUserToProject
Summary: Add user to a project
Description: Add an existing user to a project.

Syntax:
Harvest.AddUserToProject (string project_id,
AddUserToProjectParameterBody body)

Parameters:
Name Type Summary Required Related
Action
project_id string Project Id True ListProjects
(Project Id)
body AddUserToProjectParameterBody True

Returns:

GetTimeEntry
Summary: Get time entry by id
Description: Get an existing time entry by id.

946 | P a g e
 Harvest

Syntax:
Harvest.GetTimeEntry (string DAY_ENTRY_ID)

Parameters:
Name Type Summary Required Related
Action
DAY_ENTRY_ID string True
(Time Entry
Id)

Returns:
Type:UpdateTimeEntry_Response

ListTasks
Summary: List tasks
Description: Retrieves a list of all tasks.

Syntax:
Harvest.ListTasks ()

Returns:
Type:array of (ListTasksResponseItem)

GetUser
Summary: Get user info
Description: Retrieve a user's details by user id or email.

Syntax:

947 | P a g e
 Harvest

Harvest.GetUser (string USERID)

Parameters:
Name Type Summary Required Related
Action
USERID string User id or email True
(User id or
email)

Returns:
Type:GetUserByID_Response

Triggers:
Trigger TrigNewUser
Summary: When a user is added
Description: Triggers when a new user is added.

Syntax:
Harvest.TrigNewUser ()

Returns:
Type:array of (GetUserByID_Response)

Trigger TrigNewClient
Summary: When a client is added
Description: Triggers when a new client is added.

Syntax:

948 | P a g e
 Harvest

Harvest.TrigNewClient ()

Returns:
Type:array of (TrigNewClientResponseItem)

Trigger TrigNewContact
Summary: When a contact is added
Description: Triggers when a new contact is added.

Syntax:
Harvest.TrigNewContact ()

Returns:
Type:array of (TrigNewContactResponseItem)

Trigger TrigNewProject
Summary: When a project is created
Description: Triggers when a new project is created.

Syntax:
Harvest.TrigNewProject ()

Returns:
Type:array of (TrigNewProjectResponseItem)

Trigger TrigNewTimeEntryToday
Summary: When a time entry is created for the current day
Description: Triggers when a new time entry is created for the current day.

949 | P a g e
 Harvest

Syntax:
Harvest.TrigNewTimeEntryToday ([Optional]string of_user)

Parameters:
Name Type Summary Required Related
Action
of_user string The id of the False ListAllUsers
(Other user to check
User ID) time entries for.
Defaults to your
id.

Returns:
Type:GetTimeEntriesForDay_Response

Trigger TrigNewTimeEntry
Summary: When a time entry is created for date
Description: Triggers when a new time entry is created for a specific date.

Syntax:
Harvest.TrigNewTimeEntry (string date,
[advanced][Optional]string of_user)

Parameters:
Name Type Summary Required Related
Action
date string YYYY-MM-DD or True
(Date) ISO format
datetime

950 | P a g e
 Harvest

of_user string The id of the False ListAllUsers

(Other user to check
User ID) time entries for.

Returns:
Type:GetTimeEntriesForDay_Response

951 | P a g e
 Harvest

AddNewClientParameterBody
Summary:
Description:

Properties:
Name Type Summary
client Client

Client
Summary:
Description:

Properties:
Name Type Summary
name string Client's name
Name
active boolean

currency string The currency you'd like to

Currency use for the client.
currency_symbol string Symbol that correlates to
Currency symbol the selected currency.
details string Additional details,
Details normally used for address
information.

952 | P a g e
 Harvest

AddNewContactParameterBody
Summary:
Description:

Properties:
Name Type Summary
contact Contact contact

Contact
Summary:
Description: contact

Properties:
Name Type Summary
client_id integer(int32) Unique identifier of the
Client id client.
first_name string Contact's first name.
First name
last_name string Contact's last name.
Last name
email string Contact's email.
Email
phone_office string Contact's office phone.
Office phone
phone_mobile string Contact's mobile phone.
Mobile phone
fax string Contact's fax.
Fax

953 | P a g e
 Harvest

title string Contact's title.

Title

954 | P a g e
 Harvest

AddUserToProjectParameterBody
Summary:
Description:

Properties:
Name Type Summary
user User

User
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) User
User Id

955 | P a g e
 Harvest

CreateTimeEntryParameterBody
Summary:
Description:

Properties:
Name Type Summary
notes string

hours integer(int32)

project_id string Project

Project Id
task_id string Task
Task Id
spent_at string Spent at
Date

956 | P a g e
 Harvest

CreateUserParameterBody
Summary:
Description:

Properties:
Name Type Summary
user User

User
Summary:
Description:

Properties:
Name Type Summary
email string
Email
is_admin boolean
Is admin
first_name string
First name
last_name string
Last name
is_contractor boolean
Is contractor
telephone string
Phone
is_active boolean

957 | P a g e
 Harvest

has_access_to_all_future_projects boolean

default_hourly_rate number(float) Default hourly rate.

Hourly rate
department string
Department
cost_rate number(float)
Cost rate
timezone string

958 | P a g e
 Harvest

GetTimeEntriesForDay_Response
Summary:
Description:

Properties:
Name Type Summary
day_entries array of (Day_entriesItem) day_entries
day_entries
for_day string for_day
for_day

Day_entriesItem
Summary:
Description:

Properties:
Name Type Summary
project_id string Unique identifier of the
Project id porject.
project string Name of the project.
Project name
user_id integer(int32) Unique identifier of the
User id user.
spent_at string YYYY-MM-DD
Date
task_id string Id of task the time entry is
Task id associated with.
task string Name of task the time
Task entry is associated with.

959 | P a g e
 Harvest

client string Name of client the time

Client entry is associated with.
id integer(int32) Unique identifier of the
Time entry id time entry.
notes string Time entry notes.
Notes
started_at string YYYY-MM-DDThh:mm:ssZ
Started date-time (UTC format).
ended_at string YYYY-MM-DDThh:mm:ssZ
Ended date-time (UTC format).
created_at string(date-time) YYYY-MM-DDThh:mm:ssZ
Created date-time (UTC format).
updated_at string(date-time) YYYY-MM-DDThh:mm:ssZ
Updated date-time (UTC format).
hours_without_timer number(float) Current amount of time
Hours without timer tracked, if timer is not
running.
hours number(float) Number of (decimal time)
Hours hours tracked in this time
entry.

960 | P a g e
 Harvest

GetUserByID_Response
Summary:
Description:

Properties:
Name Type Summary
user User

User
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Unique identifier of
User id the user.
email string User's email.
Email
created_at string(date-time) YYYY-MM-
Created date-time DDThh:mm:ssZ (UTC
format).
is_admin boolean True if the user is an
Is admin admin.
first_name string User's first name.
First name
last_name string User's last name.
Last name
timezone string

961 | P a g e
 Harvest

is_contractor boolean True if the user is a

Is contractor contractor.
telephone string User's phone.
Phone
is_active boolean True if the user is
Is active currently active.
has_access_to_all_future_projects boolean

default_hourly_rate number(float) User's hourly rate

Hourly rate
department string Department name the
Department user works in.
wants_newsletter boolean True if the user wants
Newsletter to subscribe to the
subscription newsletter.
updated_at string(date-time) YYYY-MM-
Updated date-time DDThh:mm:ssZ (UTC
format).
cost_rate number(float) User's cost rate.
Cost rate
weekly_capacity integer(int32) User's weekly
Weekly capacity capacity.
signup_redirection_cookie string

962 | P a g e
 Harvest

ListTasksResponseItem
Summary:
Description:

Properties:
Name Type Summary
task Task

Task
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Unique identifier of the
Task id task.
name string Task name.
Name
billable_by_default boolean
internal
created_at string(date-time) YYYY-MM-DDThh:mm:ssZ
Created date-time (UTC).
updated_at string(date-time) YYYY-MM-DDThh:mm:ssZ
Updated date-time (UTC).
is_default boolean

default_hourly_rate number(float) Default rate for the task.

Default hourly rate

963 | P a g e
 Harvest

deactivated boolean

964 | P a g e
 Harvest

TrigNewClientResponseItem
Summary:
Description:

Properties:
Name Type Summary
client Client

Client
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Unique identifier of the
Client id client.
name string Client's name.
Name
active boolean

currency string Currency to use for client

Currency billing.
cache_version integer(int32)

updated_at string(date-time) YYYY-MM-DDThh:mm:ssZ

Updated date-time (UTC format).
created_at string(date-time) YYYY-MM-DDThh:mm:ssZ
Created date-time (UTC format).

965 | P a g e
 Harvest

statement_key string

default_invoice_kind string

default_invoice_timeframe string

address string Client's address.

Address
currency_symbol string Symbol that correlates to
Currency symbol the selected currency.
details string Additional details,
Details normally used for
address information.
last_invoice_kind string

966 | P a g e
 Harvest

TrigNewContactResponseItem
Summary:
Description:

Properties:
Name Type Summary
contact Contact contact

Contact
Summary:
Description: contact

Properties:
Name Type Summary
id integer(int32) Unique identifier of the
Contact id contact.
client_id integer(int32) Unique identifier of the
Client id client.
first_name string Contact's first name.
First name
last_name string Contact's last name.
Last name
email string Contact's email.
Email
phone_office string Contact's office phone.
Office phone
phone_mobile string Contact's mobile phone.
Mobile phone

967 | P a g e
 Harvest

fax string Contact's fax.

Fax
title string Contact's title.
Title
created_at string(date-time) YYYY-MM-DDThh:mm:ssZ
Created date-time (UTC format).
updated_at string(date-time) YYYY-MM-DDThh:mm:ssZ
Updated date-time (UTC format).

968 | P a g e
 Harvest

TrigNewProjectResponseItem
Summary:
Description:

Properties:
Name Type Summary
project Project

Project
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Unique identifier of
Project id the project.
client_id integer(int32) Id of client for the
Client id project.
name string Project name.
Name
code string Project code.
Code
active boolean True if the project is
Is active currently active.
billable boolean True if the project is
Is billable billable.
bill_by string Method by which the
Bill by project is invoiced.

969 | P a g e
 Harvest

hourly_rate string Billing rate by the

Hourly rate hour.
budget string Budget value for the
Budget project.
budget_by string Budgeting method
Budget by for the project.
notify_when_over_budget boolean

over_budget_notification_percentage number(float)

over_budget_notified_at string

show_budget_to_all boolean

created_at string(date-time) YYYY-MM-

Created date-time DDThh:mm:ssZ (UTC
format).
updated_at string(date-time) YYYY-MM-
Updated date-time DDThh:mm:ssZ (UTC
format).
starts_on string YYYY-MM-DD
Start date
ends_on string YYYY-MM-DD
End date
estimate string Project estimate.
Estimate
estimate_by string Method of
Estimated by estimation for
project.

970 | P a g e
 Harvest

hint_earliest_record_at string YYYY-MM-DD

Earliest record date
hint_latest_record_at string YYYY-MM-DD
Latest record date
notes string Project notes.
Notes
cost_budget string Budget value for
Cost budget Total Project Fees
projects.
cost_budget_include_expenses boolean Option for budget of
Cost budget includes Total Project Fees
expenses projects to include
tracked expenses.

971 | P a g e
 Harvest

UpdateTimeEntryParameterBody
Summary:
Description:

Properties:
Name Type Summary
project_id string Project
Project Id
task_id string Task
Task Id
notes string
Notes
started_at string YYYY-MM-DDThh:mm:ssZ
Started date-time (UTC format).
ended_at string YYYY-MM-DDThh:mm:ssZ
Ended date-time (UTC format).
spent_at string YYYY-MM-DDThh:mm:ssZ
Date (UTC format).

972 | P a g e
 Harvest

UpdateTimeEntry_Response
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Unique identifier of the
Time entry id time entry.
user_id integer(int32) Unique identifier of the
User id user who created the
time entry.
spent_at string Date of time entry.
Date
created_at string(date-time) YYYY-MM-DDThh:mm:ssZ
Created date-time (UTC format).
updated_at string(date-time) YYYY-MM-DDThh:mm:ssZ
Updated date-time (UTC format).
project_id string Id of the project time
Project id entry is associated with.
task_id string Id of the task time entry is
Task id associated with.
project string Name of project the time
Project entry is associated with.
task string Name of task the time
Task entry is associated with.
client string Name of client the time
Client entry is associated with.
notes string Time entry notes.
Notes

973 | P a g e
 Harvest

hours_without_timer number(float) Current amount of time

Hours without timer tracked, if timer is not
running.
hours number(float) Number of (decimal time)
Hours hours tracked in this time
entry.

974 | P a g e
 HelloSign

HelloSign
HelloSign enables secure electronic signatures that are business-caliber, easy-
to-use and legally binding.

Status: Preview Tier: Premium Version: 1.0.0

Actions:
Name Summary
CreateRequest Send signature request from template
([Optional]string test_mode,
string template_id,
[advanced][Optional]string
subject,
[advanced][Optional]string
message,
[advanced][Optional]string
signing_redirect_url,
[advanced][Optional]boolean
allow_decline,
DynamicSigners signers)
GetRequest (string requestId) Get signature request
ListTemplates () List templates
ListSignatureRequests () List signature requests
CancelRequest (string Cancel signature request
requestId)
GetDynamicSigners (string Get the signers of a template in dynamic schema
template_id) format.

975 | P a g e
 HelloSign

Triggers:
Name Summary
OnNewRequest () When a signature request is created
OnRequestCompleted () When a signature request is completed
OnRequestDeclined () When a signature request is declined

Objects:
Name Summary
DynamicSigners
List_templates_Response
RequestResponse

Actions:
CreateRequest
Summary: Send signature request from template
Description: Create and send a new signature request based off an existing template.

Syntax:
HelloSign.CreateRequest ([Optional]string test_mode, string
template_id, [advanced][Optional]string subject,
[advanced][Optional]string message, [advanced][Optional]string
signing_redirect_url, [advanced][Optional]boolean allow_decline,
DynamicSigners signers)

Parameters:
Name Type Summary Required Related
Action
test_mode string False

976 | P a g e
 HelloSign

(Account
type)Values:
[Free, Paid]
template_id string True ListTemplates
(Template id)
subject string False
(Subject)
message string False
(Message)
signing_redirect_url string False
(Redirect URL)
allow_decline boolean False
(Allow Decline)
signers DynamicSigners An object True
that
represents
signers based
on a
template.

Returns:
Type:RequestResponse

GetRequest
Summary: Get signature request
Description: Get a signature request that includes the current status for each signer.

Syntax:
HelloSign.GetRequest (string requestId)

977 | P a g e
 HelloSign

Parameters:
Name Type Summary Required Related Action
requestId string True ListSignatureRequests
(Request
Id)

Returns:
Type:RequestResponse

ListTemplates
Summary: List templates
Description: List templates

Syntax:
HelloSign.ListTemplates ()

Returns:
Type:List_templates_Response

ListSignatureRequests
Summary: List signature requests
Description: Lists the SignatureRequests (both inbound and outbound) that you have
access to.

Syntax:
HelloSign.ListSignatureRequests ()

Returns:

978 | P a g e
 HelloSign

Type:array of (RequestResponse)

CancelRequest
Summary: Cancel signature request
Description: Cancel an existing signature request.

Syntax:
HelloSign.CancelRequest (string requestId)

Parameters:
Name Type Summary Required Related Action
requestId string True ListSignatureRequests
(Request
Id)

Returns:

GetDynamicSigners
Summary: Get the signers of a template in dynamic schema format.
Description: Get the signers of a template in dynamic schema format.

Syntax:
HelloSign.GetDynamicSigners (string template_id)

Parameters:
Name Type Summary Required Related
Action
template_id string True

979 | P a g e
 HelloSign

(Template
Id)

Returns:
Type:string

Triggers:
Trigger OnNewRequest
Summary: When a signature request is created
Description: Triggers when a new signature request is created.

Syntax:
HelloSign.OnNewRequest ()

Returns:
Type:array of (RequestResponse)

Trigger OnRequestCompleted
Summary: When a signature request is completed
Description: Triggers when a signature request is completed by all parties.

Syntax:
HelloSign.OnRequestCompleted ()

Returns:
Type:array of (RequestResponse)

Trigger OnRequestDeclined
Summary: When a signature request is declined
980 | P a g e
 HelloSign

Description: Triggers when a signature request is decline.

Syntax:
HelloSign.OnRequestDeclined ()

Returns:
Type:array of (RequestResponse)

981 | P a g e
 HelloSign

DynamicSigners
Summary:
Description: An object that represents signers based on a template.

Properties:
Name Type Summary

982 | P a g e
 HelloSign

List_templates_Response
Summary:
Description:

Properties:
Name Type Summary
templates array of (TemplatesItem) templates
templates

TemplatesItem
Summary:
Description:

Properties:
Name Type Summary
template_id string template_id
template_id
title string title
title

983 | P a g e
 HelloSign

RequestResponse
Summary:
Description:

Properties:
Name Type Summary
signature_request_id string Unique id of the
Request id signature request.
title string Signature request title.
Title
subject string Subject of the email sent
Subject to signers.
message string Custom message in the
Message email sent to signers.
is_complete boolean True if the request has
Is complete been fully executed by all
signers.
is_declined boolean True if the request has
Is declined been declined by a
signer.
signing_url string Url where a signer, after
Signing Url authenticating, can sign
the documents.
details_url string Url where the requester
Details Url and the signers can view
the current status of the
request.

984 | P a g e
 HelloSign

requester_email_address string Email address of the

Requester email initiator of the signature
request.
signatures array of (SignaturesItem)
Signatures

SignaturesItem
Summary:
Description:

Properties:
Name Type Summary
signature_id string Unique identifier of the
Signature Id signature.
signer_email_address string Email address of the
Signer Email signer.
signer_name string Name of the signer.
Signer Name
status_code string Current status of the
Status Code signature.
signed_at string(date) Date in ISO UTC format
Signed Date (yyyy-MM-
ddTHH:mm:ss.fffZ)
last_viewed_at string(date) Date in ISO UTC format
Last Viewed Date (yyyy-MM-
ddTHH:mm:ss.fffZ)
last_reminded_at string Date in ISO UTC format
Last Reminded Date (yyyy-MM-
ddTHH:mm:ss.fffZ)

985 | P a g e
 HelloSign

986 | P a g e
 HipChat

HipChat
HipChat is group chat, video chat and screen sharing tool for teams of all sizes.
Built for business, HipChat is persistent, searchable and loaded with goodies
your team will love.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
ListUsers (string roomId) List users in a room
GetUserByID (string userid) Get user by Id
PostMessage (string roomId, Post message to a room
PostMessageParameterBody
body)
ListRooms () List Rooms
AddUserToRoom (string Add a user to a room
roomId, string memberid)

Triggers:
Name Summary
OnNewMessage (string When a message is posted to a room
roomId)
OnNewFile (string roomId) When a file is uploaded to a room
OnNewRoom () When a new room is added

Objects:
Name Summary

987 | P a g e
 HipChat

HistoryResponse
NewMessage
PostMessageParameterBody
RoomList
UserList
UserResponse

Actions:
ListUsers
Summary: List users in a room
Description: Gets all members of an existing room.

Syntax:
HipChat.ListUsers (string roomId)

Parameters:
Name Type Summary Required Related
Action
roomId string Room True ListRooms
(Room ID)

Returns:
Type:UserList

GetUserByID
Summary: Get user by Id
Description: Get a user's details by user id.

Syntax:
988 | P a g e
 HipChat

HipChat.GetUserByID (string userid)

Parameters:
Name Type Summary Required Related
Action
userid string True
(User Id)

Returns:
Type:UserResponse

PostMessage
Summary: Post message to a room
Description: Post new message to an existing room.

Syntax:
HipChat.PostMessage (string roomId, PostMessageParameterBody
body)

Parameters:
Name Type Summary Required Related
Action
roomId string Room True ListRooms
(Room ID)
body PostMessageParameterBody True

Returns:
Type:NewMessage

989 | P a g e
 HipChat

ListRooms
Summary: List Rooms
Description: List the rooms the user has access to.

Syntax:
HipChat.ListRooms ()

Returns:
Type:RoomList

AddUserToRoom
Summary: Add a user to a room
Description: Adds a member to a private room.

Syntax:
HipChat.AddUserToRoom (string roomId, string memberid)

Parameters:
Name Type Summary Required Related
Action
roomId string Room True ListRooms
(Room ID)
memberid string The id, email or True
(User Id or mention name
Email) of the user.

Returns:
Type:string

990 | P a g e
 HipChat

Triggers:
Trigger OnNewMessage
Summary: When a message is posted to a room
Description: Triggers when a new message is posted to an existing room.

Syntax:
HipChat.OnNewMessage (string roomId)

Parameters:
Name Type Summary Required Related
Action
roomId string Room True ListRooms
(Room ID)

Returns:
Type:HistoryResponse

Trigger OnNewFile
Summary: When a file is uploaded to a room
Description: Triggers when a file is uploaded an existing room.

Syntax:
HipChat.OnNewFile (string roomId)

Parameters:
Name Type Summary Required Related
Action

991 | P a g e
 HipChat

roomId string Room True ListRooms

(Room ID)

Returns:
Type:HistoryResponse

Trigger OnNewRoom
Summary: When a new room is added
Description: Triggers when a room is created.

Syntax:
HipChat.OnNewRoom ()

Returns:
Type:RoomList

992 | P a g e
 HipChat

HistoryResponse
Summary:
Description:

Properties:
Name Type Summary
items array of (ItemsItem)

ItemsItem
Summary:
Description:

Properties:
Name Type Summary
date string(date-time) Date the message was
Date Posted sent in ISO-8601 format.
file File

from From

id string Unique id of the message.

Message Id
message string Body of the message.
Message

File
Summary:
Description:

993 | P a g e
 HipChat

Properties:
Name Type Summary
name string Name of the file.
File Name
url string URL of the file.
File URL

From
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Author's user id.
User Id
mention_name string Author's mention name.
Mention Name
name string Author's display user
User Name name.

994 | P a g e
 HipChat

NewMessage
Summary:
Description:

Properties:
Name Type Summary
id string Unique id of the message.
Message Id
timestamp string Date the message was
Date Posted sent in ISO-8601 format.

995 | P a g e
 HipChat

PostMessageParameterBody
Summary:
Description:

Properties:
Name Type Summary
message string Text of the message.
Message

996 | P a g e
 HipChat

RoomList
Summary:
Description:

Properties:
Name Type Summary
items array of (ItemsItem)

ItemsItem
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Id of the room.
Room Id
is_archived boolean True if the room is
Archived archived.
name string Name of the room.
Room Name
privacy string True if the room is
Private private.

997 | P a g e
 HipChat

UserList
Summary:
Description:

Properties:
Name Type Summary
items array of (ItemsItem)

ItemsItem
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Member's user id.
User Id
is_present_in_room boolean User Is Present.
User Is Present
mention_name string Member's mention
Mention Name name.
name string Member's display user
User Name name.

998 | P a g e
 HipChat

UserResponse
Summary:
Description:

Properties:
Name Type Summary
email string User's email.
Email
id integer(int32) User's id.
User Id
mention_name string User's @mention name.
Mention Name
name string User's full name.
Name

999 | P a g e
 Infusionsoft

Infusionsoft
Infusionsoft is sales and marketing automation software built exclusively for
small business success.

Status: Preview Tier: Premium Version: 1.0.0

Actions:
Name Summary
CreateTask Create a task
(CreateTask_Request body,
[internal]string Content-Type)
UpdateTask (integer id, Update a task
CreateTask_Request body,
[internal]string Content-Type)
ListTasks ([internal]string List tasks
order)

Triggers:
Name Summary
OnNewTask ([internal]string When a new task is created
order)
OnNewOrder () When there is a new order

Objects:
Name Summary
CreateTask_Request
ListTasks_Response

1000 | P a g e
 Infusionsoft

OnNewOrderResponseItem
Task_Response

Actions:
CreateTask
Summary: Create a task
Description: Create a new task.

Syntax:
Infusionsoft.CreateTask (CreateTask_Request body,
[internal]string Content-Type)

Parameters:
Name Type Summary Required Related
Action
body CreateTask_Request True

Content-Type string True

(Content-Type)

Returns:
Type:Task_Response

UpdateTask
Summary: Update a task
Description: Update an existing task.

Syntax:

1001 | P a g e
 Infusionsoft

Infusionsoft.UpdateTask (integer id, CreateTask_Request body,

[internal]string Content-Type)

Parameters:
Name Type Summary Required Related
Action
id integer Id of the task. True ListTasks
(Id)
body CreateTask_Request True

Content-Type string True

(Content-Type)

Returns:
Type:Task_Response

ListTasks
Summary: List tasks
Description: Retrieve a page of tasks ordered by due date.

Syntax:
Infusionsoft.ListTasks ([internal]string order)

Parameters:
Name Type Summary Required Related
Action
order string True
(order)

1002 | P a g e
 Infusionsoft

Returns:
Type:ListTasks_Response

Triggers:
Trigger OnNewTask
Summary: When a new task is created
Description: Trigger a flow on a new task.

Syntax:
Infusionsoft.OnNewTask ([internal]string order)

Parameters:
Name Type Summary Required Related
Action
order string True
(order)

Returns:
Type:array of (Task_Response)

Trigger OnNewOrder
Summary: When there is a new order
Description: Trigger an action when there is a new order.

Syntax:
Infusionsoft.OnNewOrder ()

Returns:
Type:array of (OnNewOrderResponseItem)
1003 | P a g e
 Infusionsoft

Summary: orders
Description: orders

1004 | P a g e
 Infusionsoft

CreateTask_Request
Summary:
Description:

Properties:
Name Type Summary
title string The title of the task.
Title
description string A description of the task
Description title.
type string Type of the task. Values:
Type [Call, Email, Appointment,
Fax, Letter, Other]
priority integer(int32) Priority of the task (1, 2, 3,
Priority etc.)
due_date string(date-time) Due date of the task (Ex.
Due date (format: YYYY- 2014-06-17T17:12:52.000Z
MM-ddThh:mm:ss.fffZ)

1005 | P a g e
 Infusionsoft

ListTasks_Response
Summary:
Description:

Properties:
Name Type Summary
tasks array of (TasksItem) Collection of tasks.
Tasks

TasksItem
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) An integer that uniquely
Id identifies this task.
title string The actual task name (Do
Title this thing).
description string A description of the task
Description defined by the user.
type string A string representing the
Type type of Task as defined by
the user from a list of
types editable in the
Infusionsoft application.
priority integer(int32) The priority of the task.
Priority

1006 | P a g e
 Infusionsoft

completed boolean A boolean indicating the

Completed completed status of the
task.
url string The link to the task.
URL
due_date string(date-time) The datetime the task is
Due Date due, given as GMT in ISO
8601 format.

1007 | P a g e
 Infusionsoft

OnNewOrderResponseItem
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) The unique id of the
Id order.
title string Name given to the
Title order.
status string The status of the order.
Status
total number(float) Total amount of the
Total order.
shipping_information Shipping_information Shipping info for the
Shipping order.
contact Contact Order contact.
Contact
creation_date string(date-time) Creation date of the
Creation Date order.
order_date string(date-time) Order date of the order.
Order Date
total_paid number(float) Total paid amount of
Total Paid the order.
total_due number(float) Total amount due for
Total Due the order.

Shipping_information
Summary: Shipping

1008 | P a g e
 Infusionsoft

Description: Shipping info for the order.

Properties:
Name Type Summary
first_name string First name of the shipping
First Name address.
middle_name string Middle name of the
Middle Name shipping address.
last_name string Last name name of the
Last Name shipping address.
company string Company associated with
Company the shipping address.
phone string Phone number associated
Phone Number with the shipping address.
street1 string First street line of the
Street Line 1 shipping address.
street2 string Second street line of the
Street Line 2 shipping address.
city string The city in the shipping
City address.
state string The state in the shipping
State address.
zip string The zip code in the
Zip shipping address.
country string The country in the
Country shipping address.

Contact
Summary: Contact

1009 | P a g e
 Infusionsoft

Description: Order contact.

Properties:
Name Type Summary
email string Email address of the
Email Address contact.
first_name string First name of the contact.
First Name
last_name string Last name of the contact.
Last Name
company_name string Company of the contact.
Company
job_title string Job Title of the contact.
Job Title

1010 | P a g e
 Infusionsoft

Task_Response
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) An integer that uniquely
Id identifies this task.
title string The actual task name (Do
Title this thing).
description string A description of the task
Description defined by the user.
type string A string representing the
Type type of Task as defined by
the user from a list of
types editable in the
Infusionsoft application.
priority integer(int32) The priority of the task.
Priority
completed boolean A boolean indicating the
Completed completed status of the
task.
url string The link to the task.
URL
due_date string(date-time) The datetime the task is
Due Date due, given as GMT in ISO
8601 format.

1011 | P a g e
 Inoreader

Inoreader
Inoreader is a content reader built for power users. Use Inoreader to subscribe
to feeds, read articles or catalogue them for viewing later.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
AddSubscription Add subscription
(AddSubscriptionParameterBody
body)
EditSubscription (string Edit subscription
streamId,
EditSubscriptionParameterBody
body)
UnsubscribeSubscription (string Unsubscribe subscription
streamId)
RemoveSubscriptionFromFolder Remove a subscription from a folder
(string streamId, string tagId)
AddSubscriptionToFolder (string Add a subscription to a folder
streamId, string tagId)
DeleteTag (string tagId) Delete tag
GetUnreadCountForStream Get number of unread items in a stream
(string streamId)
GetUnreadCount () Get number of unread items
GetSubscriptions () Get subscriptions
GetTags () Get tag list

1012 | P a g e
 Inoreader

StreamContents (string Stream contents

streamId, [Optional]integer n)

Triggers:
Name Summary
OnNewSubscription () When a new subscription is added
OnUnreadItemCountForStreamExceedsTarget When unread count reaches a
(string streamId, integer target) target

Objects:
Name Summary
AddSubscriptionParameterBody
AddSubscriptionResponse
EditSubscriptionParameterBody
GetSubscriptions_Response
StreamContentsResponseItem
Subscription
Tag
UnreadCount

Actions:
AddSubscription
Summary: Add subscription
Description: Add a new subscription.

Syntax:
Inoreader.AddSubscription (AddSubscriptionParameterBody body)

1013 | P a g e
 Inoreader

Parameters:
Name Type Summary Required Related
Action
body AddSubscriptionParameterBody True

Returns:
Type:AddSubscriptionResponse

EditSubscription
Summary: Edit subscription
Description: Edit the information for a specific subscription.

Syntax:
Inoreader.EditSubscription (string streamId,
EditSubscriptionParameterBody body)

Parameters:
Name Type Summar Require Related Action
y d
streamI string True GetSubscription
d (Subscription Id) s
body EditSubscriptionParameterBod True
y

Returns:
Type:string

1014 | P a g e
 Inoreader

UnsubscribeSubscription
Summary: Unsubscribe subscription
Description: Unsubscribe from a subscription.

Syntax:
Inoreader.UnsubscribeSubscription (string streamId)

Parameters:
Name Type Summary Required Related Action
streamId string True GetSubscriptions
(Subscription
Id)

Returns:
Type:string

RemoveSubscriptionFromFolder
Summary: Remove a subscription from a folder
Description: Remove a subscription from a specific folder.

Syntax:
Inoreader.RemoveSubscriptionFromFolder (string streamId, string
tagId)

Parameters:
Name Type Summary Required Related Action
streamId string True GetSubscriptions
(Subscription
Id)

1015 | P a g e
 Inoreader

tagId string True GetTags

(Folder Id)

Returns:
Type:string

AddSubscriptionToFolder
Summary: Add a subscription to a folder
Description: Add a subscription to a specific folder.

Syntax:
Inoreader.AddSubscriptionToFolder (string streamId, string
tagId)

Parameters:
Name Type Summary Required Related Action
streamId string True GetSubscriptions
(Subscription
Id)
tagId string True GetTags
(Folder Id)

Returns:
Type:string

DeleteTag
Summary: Delete tag
Description: Delete a tag from the account.

1016 | P a g e
 Inoreader

Syntax:
Inoreader.DeleteTag (string tagId)

Parameters:
Name Type Summary Required Related
Action
tagId string The full tag True GetTags
(Tag Id) name, like user/-
/label/Tech

Returns:
Type:string

GetUnreadCountForStream
Summary: Get number of unread items in a stream
Description: Get the number of unread items for a specific stream.

Syntax:
Inoreader.GetUnreadCountForStream (string streamId)

Parameters:
Name Type Summary Required Related Action
streamId string True GetSubscriptions
(Subscription
Id)

Returns:
Type:UnreadCount

1017 | P a g e
 Inoreader

GetUnreadCount
Summary: Get number of unread items
Description: Get the number of unread items across all streams.

Syntax:
Inoreader.GetUnreadCount ()

Returns:
Type:array of (UnreadCount)

GetSubscriptions
Summary: Get subscriptions
Description: Get a list of subscriptions.

Syntax:
Inoreader.GetSubscriptions ()

Returns:
Type:array of (GetSubscriptions_Response)

GetTags
Summary: Get tag list
Description: Get a list of tags.

Syntax:
Inoreader.GetTags ()

Returns:
Type:array of (Tag)

1018 | P a g e
 Inoreader

StreamContents
Summary: Stream contents
Description: Lists the articles for a given collection.

Syntax:
Inoreader.StreamContents (string streamId, [Optional]integer n)

Parameters:
Name Type Summary Required Related Action
streamId string True GetSubscriptions
(Subscription
Id)
n integer Number of False
(Number of items to
items) return (default
20, max
1000).

Returns:
Type:array of (StreamContentsResponseItem)

Triggers:
Trigger OnNewSubscription
Summary: When a new subscription is added
Description: Triggers when a new subscription is added to your account.

Syntax:
Inoreader.OnNewSubscription ()

1019 | P a g e
 Inoreader

Returns:
Type:array of (Subscription)

Trigger OnUnreadItemCountForStreamExceedsTarget
Summary: When unread count reaches a target
Description: Triggers when the number of unread items for a subscription reaches or
exceeds the target value.

Syntax:
Inoreader.OnUnreadItemCountForStreamExceedsTarget (string
streamId, integer target)

Parameters:
Name Type Summary Required Related Action
streamId string True GetSubscriptions
(Subscription
Id)
target integer(int32) The target True
(Target number of
Count) unread items.

Returns:
Type:UnreadCount

1020 | P a g e
 Inoreader

AddSubscriptionParameterBody
Summary:
Description:

Properties:
Name Type Summary
quickadd string ID of the stream to add, , e.g.
feed/http://feeds.arstechnica.com/arstechnica/science

1021 | P a g e
 Inoreader

AddSubscriptionResponse
Summary:
Description:

Properties:
Name Type Summary
numResults boolean Whether adding the
subscription was
successful.
streamId string The Id of the stream.

streamName string The name of the stream.

1022 | P a g e
 Inoreader

EditSubscriptionParameterBody
Summary:
Description:

Properties:
Name Type Summary
t string The title of the
subscription.

1023 | P a g e
 Inoreader

GetSubscriptions_Response
Summary:
Description:

Properties:
Name Type Summary
id string The feed identifier.

title string The title of the feed.

sortid string

timestamp string(date-time) A timestamp of the first

item in the feed.
url string Actual XML URL of the
feed.
htmlUrl string The link to the feed
website.
iconUrl string The feed favicon in 16x16
pixels.

1024 | P a g e
 Inoreader

StreamContentsResponseItem
Summary:
Description:

Properties:
Name Type Summary
author string

url string

id string

published string yyyy-MM-

ddTHH:mm:ss.fffZ
summary Summary summary

timestamp string(date-time) A timestamp of the newest

item.
title string

updated string yyyy-MM-

ddTHH:mm:ss.fffZ

Summary
Summary:
Description: summary

Properties:
Name Type Summary

1025 | P a g e
 Inoreader

content string

direction string

1026 | P a g e
 Inoreader

Subscription
Summary:
Description:

Properties:
Name Type Summary
id string The feed identifier.

title string The title of the feed.

categories array of (CategoriesItem)

sortid string

timestamp string(date-time) A timestamp of the first

item in the feed.
url string Actual XML URL of the
feed.
htmlUrl string The link to the feed
website.
iconUrl string The feed favicon in 16x16
pixels.

CategoriesItem
Summary:
Description:

Properties:
Name Type Summary

1027 | P a g e
 Inoreader

id string The identifier of the

category.
label string The label of the category.

1028 | P a g e
 Inoreader

Tag
Summary:
Description:

Properties:
Name Type Summary
id string Unique tag id.

sortid string Id for sorting.

niceTitle string Title

1029 | P a g e
 Inoreader

UnreadCount
Summary:
Description:

Properties:
Name Type Summary
count integer(int32) The count of unread
items.
timestamp string(date-time) A timestamp of the
newest item.

1030 | P a g e
 Insightly

Insightly
Insightly is the easiest customer relationship management solution (CRM) to
use for managing deep customer relationships. Customers use Insightly's
tightly integrated CRM & project management features to close new business,
track post sale customer interactions & drive repeat purchases.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
ListTasks () List tasks
UpdateTask (string id, Update task
TaskRequest updatedTask)
AddTask (TaskRequest Add task
newTask)
ListProjects () List projects
UpdateProject (string id, Update project
ProjectRequest
updatedProject)
AddProject (ProjectRequest Add project
newProject)
ListLeads () List leads
UpdateLead (string id, Update lead
LeadRequest updatedLead)
AddLead (LeadRequest Add lead
newLead)
ListContacts () List contacts

1031 | P a g e
 Insightly

UpdateContact (string id, Update contact

ContactRequest
updatedContact)
AddContact (ContactRequest Add contact
newContact)
ListUsers () List users
DeleteTask (integer taskId) Delete task
FollowTask (integer taskId) Follow a task
DeleteProject (integer Delete project
projectId)
DeleteLead (integer leadId) Delete lead
DeleteContact (integer Delete contact
contactId)
AddOrganization Add organization
(OrganizationRequest
newOrganization)

Triggers:
Name Summary
OnTaskAssignedToMe () When a task is assigned to me
OnTaskCreated () When a task is created
OnTaskUpdated () When a task is updated
OnProjectCreated () When a project is created
OnProjectUpdated () When a project is updated
OnLeadCreated () When a lead is created
OnLeadUpdated () When a lead is updated
OnContactCreated () When a contact is created
OnContactUpdated () When a contact is updated

1032 | P a g e
 Insightly

OnEventCreated () When an event is created

OnEventUpdated () When an event is updated

Objects:
Name Summary
Address
Contact
ContactInfo
ContactRequest
Event
EventLink
Lead
LeadRequest
Link
ListContactsResponse
ListEventsResponse
ListLeadsResponse
ListProjectsResponse
ListTasksResponse
ListUsersResponse
Object
Organization
OrganizationRequest
Project
ProjectRequest
Tag
Task
TaskLink

1033 | P a g e
 Insightly

TaskRequest
User

Actions:
ListTasks
Summary: List tasks
Description: List tasks

Syntax:
Insightly.ListTasks ()

Returns:
Type:ListTasksResponse
Description: A Insightly Tasks response object

UpdateTask
Summary: Update task
Description: Update task

Syntax:
Insightly.UpdateTask (string id, TaskRequest updatedTask)

Parameters:
Name Type Summary Required Related
Action
id string Unique ID of the True ListTasks
(Task Id) task to update

1034 | P a g e
 Insightly

updatedTask TaskRequest An Insightly Task True

Request Object

Returns:
Type:Task
Description: An Insightly Task Object

AddTask
Summary: Add task
Description: Add task

Syntax:
Insightly.AddTask (TaskRequest newTask)

Parameters:
Name Type Summary Required Related
Action
newTask TaskRequest An Insightly Task True
Request Object

Returns:
Type:Task
Description: An Insightly Task Object

ListProjects
Summary: List projects
Description: List projects

Syntax:

1035 | P a g e
 Insightly

Insightly.ListProjects ()

Returns:
Type:ListProjectsResponse
Description: A Insightly Project response object

UpdateProject
Summary: Update project
Description: Update project

Syntax:
Insightly.UpdateProject (string id, ProjectRequest
updatedProject)

Parameters:
Name Type Summary Required Related
Action
id string Unique ID of True ListProjects
(Project Id) the project to
update
updatedProject ProjectRequest An Insightly True
Project Object

Returns:
Type:Project
Description: An Insightly Project Object

AddProject
Summary: Add project

1036 | P a g e
 Insightly

Description: Add project

Syntax:
Insightly.AddProject (ProjectRequest newProject)

Parameters:
Name Type Summary Required Related
Action
newProject ProjectRequest An Insightly True
Project Object

Returns:
Type:Project
Description: An Insightly Project Object

ListLeads
Summary: List leads
Description: List leads

Syntax:
Insightly.ListLeads ()

Returns:
Type:ListLeadsResponse
Description: A Insightly Lead response object

UpdateLead
Summary: Update lead
Description: Update lead

1037 | P a g e
 Insightly

Syntax:
Insightly.UpdateLead (string id, LeadRequest updatedLead)

Parameters:
Name Type Summary Required Related
Action
id string Unique ID of the True ListLeads
(Lead Id) lead to update
updatedLead LeadRequest An Insightly True
LeadRequest
Object

Returns:
Type:Lead
Description: An Insightly Lead Object

AddLead
Summary: Add lead
Description: Add lead

Syntax:
Insightly.AddLead (LeadRequest newLead)

Parameters:
Name Type Summary Required Related
Action

1038 | P a g e
 Insightly

newLead LeadRequest An Insightly True

LeadRequest
Object

Returns:
Type:Lead
Description: An Insightly Lead Object

ListContacts
Summary: List contacts
Description: List contacts

Syntax:
Insightly.ListContacts ()

Returns:
Type:ListContactsResponse
Description: A Insightly contact response object

UpdateContact
Summary: Update contact
Description: Update contact

Syntax:
Insightly.UpdateContact (string id, ContactRequest
updatedContact)

Parameters:

1039 | P a g e
 Insightly

Name Type Summary Required Related

Action
id string Unique ID of True ListContacts
(Contact Id) the contact to
update
updatedContact ContactRequest An Insightly True
Contact
Request
Object

Returns:
Type:Contact
Description: An Insightly Contact Object

AddContact
Summary: Add contact
Description: Add contact

Syntax:
Insightly.AddContact (ContactRequest newContact)

Parameters:
Name Type Summary Required Related
Action
newContact ContactRequest An Insightly True
Contact
Request Object

Returns:

1040 | P a g e
 Insightly

Type:Contact
Description: An Insightly Contact Object

ListUsers
Summary: List users
Description: List users

Syntax:
Insightly.ListUsers ()

Returns:
Type:ListUsersResponse
Description: A Insightly User response object

DeleteTask
Summary: Delete task
Description: Delete task

Syntax:
Insightly.DeleteTask (integer taskId)

Parameters:
Name Type Summary Required Related
Action
taskId integer(int32) Task Id True ListTasks
(Task Id)

Returns:
Type:Object

1041 | P a g e
 Insightly

FollowTask
Summary: Follow a task
Description: Follow a task

Syntax:
Insightly.FollowTask (integer taskId)

Parameters:
Name Type Summary Required Related
Action
taskId integer(int32) Task Id True
(Task Id)

Returns:
Type:Object

DeleteProject
Summary: Delete project
Description: Delete project

Syntax:
Insightly.DeleteProject (integer projectId)

Parameters:
Name Type Summary Required Related
Action
projectId integer(int32) Project Id True ListProjects

1042 | P a g e
 Insightly

(Project Id)

Returns:
Type:Object

DeleteLead
Summary: Delete lead
Description: Delete lead

Syntax:
Insightly.DeleteLead (integer leadId)

Parameters:
Name Type Summary Required Related
Action
leadId integer(int32) Lead Id True ListLeads
(Lead Id)

Returns:
Type:Object

DeleteContact
Summary: Delete contact
Description: Delete contact

Syntax:
Insightly.DeleteContact (integer contactId)

Parameters:

1043 | P a g e
 Insightly

Name Type Summary Required Related

Action
contactId integer(int32) Contact Id True ListContacts
(Contact Id)

Returns:
Type:Object

AddOrganization
Summary: Add organization
Description: Add organization

Syntax:
Insightly.AddOrganization (OrganizationRequest newOrganization)

Parameters:
Name Type Summary Required Related
Action
newOrganization OrganizationRequest An Insightly True
Organization
Request
Object

Returns:
Type:Organization
Description: An Insightly Organization Object

1044 | P a g e
 Insightly

Triggers:
Trigger OnTaskAssignedToMe
Summary: When a task is assigned to me
Description: Triggers a new flow when a task is assigned to me

Syntax:
Insightly.OnTaskAssignedToMe ()

Returns:
Type:ListTasksResponse
Description: A Insightly Tasks response object

Trigger OnTaskCreated
Summary: When a task is created
Description: Triggers a new flow when a new task is created

Syntax:
Insightly.OnTaskCreated ()

Returns:
Type:ListTasksResponse
Description: A Insightly Tasks response object

Trigger OnTaskUpdated
Summary: When a task is updated
Description: Triggers a new flow when a task is updated

Syntax:

1045 | P a g e
 Insightly

Insightly.OnTaskUpdated ()

Returns:
Type:ListTasksResponse
Description: A Insightly Tasks response object

Trigger OnProjectCreated
Summary: When a project is created
Description: Triggers a new flow when a new project is created

Syntax:
Insightly.OnProjectCreated ()

Returns:
Type:ListProjectsResponse
Description: A Insightly Project response object

Trigger OnProjectUpdated
Summary: When a project is updated
Description: Triggers a new flow when a project is updated

Syntax:
Insightly.OnProjectUpdated ()

Returns:
Type:ListProjectsResponse
Description: A Insightly Project response object

1046 | P a g e
 Insightly

Trigger OnLeadCreated
Summary: When a lead is created
Description: Triggers a new flow when a new lead is created

Syntax:
Insightly.OnLeadCreated ()

Returns:
Type:Lead
Description: An Insightly Lead Object

Trigger OnLeadUpdated
Summary: When a lead is updated
Description: Triggers a new flow when a lead is updated

Syntax:
Insightly.OnLeadUpdated ()

Returns:
Type:Lead
Description: An Insightly Lead Object

Trigger OnContactCreated
Summary: When a contact is created
Description: Triggers a new flow when a new contact is created

Syntax:
Insightly.OnContactCreated ()

1047 | P a g e
 Insightly

Returns:
Type:ListContactsResponse
Description: A Insightly contact response object

Trigger OnContactUpdated
Summary: When a contact is updated
Description: Triggers a new flow when a contact is updated

Syntax:
Insightly.OnContactUpdated ()

Returns:
Type:ListContactsResponse
Description: A Insightly contact response object

Trigger OnEventCreated
Summary: When an event is created
Description: Triggers a new flow when a new event is created

Syntax:
Insightly.OnEventCreated ()

Returns:
Type:ListEventsResponse
Description: A Insightly Event response object

Trigger OnEventUpdated
Summary: When an event is updated
Description: Triggers a new flow when an event is updated

1048 | P a g e
 Insightly

Syntax:
Insightly.OnEventUpdated ()

Returns:
Type:ListEventsResponse
Description: A Insightly Event response object

1049 | P a g e
 Insightly

Address
Summary:
Description: An Insightly Contact Address Object

Properties:
Name Type Summary
ADDRESS_ID integer(int32) The Address Id
Address Id
ADDRESS_TYPE string The Address Type
Address Type
STREET string Street
Address Street
CITY string City
Address City
STATE string State
Address State
POSTCODE string Post Code
Address Post Code
COUNTRY string Country
Address Country

1050 | P a g e
 Insightly

Contact
Summary:
Description: An Insightly Contact Object

Properties:
Name Type Summary
CONTACT_ID integer(int32) The Contact Id
Contact Id
SALUTATION string Salutation
Salutation
FIRST_NAME string First Name
First Name
LAST_NAME string Last Name
Last Name
IMAGE_URL string Contact Image URL
Image URL
DATE_CREATED_UTC string Date Created
Date Created
VISIBLE_TO string Contact Visibility
Contact Visibility
ADDRESSES array of (Address) Contact Addresses
Contact
CONTACTINFOS array of (ContactInfo) Contact Information
Contact Information
TAGS array of (Tag) Tag
Tag
LINKS array of (Link) Contact Links
Contact Links

1051 | P a g e
 Insightly

ContactInfo
Summary:
Description: An Insightly Contact Information Object

Properties:
Name Type Summary
TYPE string Contact Info Type Values:
Type [Phone, Email, Social,
Website]
SUBTYPE string Contact Info Sub-Type
SubType
LABEL string Contact Info Label
Label
DETAIL string Contact Info Detail
Detail

1052 | P a g e
 Insightly

ContactRequest
Summary:
Description: An Insightly Contact Request Object

Properties:
Name Type Summary
SALUTATION string Salutation
Salutation
FIRST_NAME string First Name
First Name
LAST_NAME string Last Name
Last Name
BACKGROUND string Background
Background
VISIBLE_TO string Contact Visibility Values:
Contact Visibility [Everyone, Individuals,
Owner, Team]
VISIBLE_TEAM_ID integer(int32) Visible Team ID (Required
Visible Team ID when team visibility state
is selected)
VISIBLE_USER_IDS integer(int32) Visible User IDs (Required
Visible User IDs when indivdiuals visibility
state is selected)
CONTACTINFOS array of (ContactInfo) Contact Information
Contact Information
TAGS array of (Tag) Tag
Tag

1053 | P a g e
 Insightly

Event
Summary:
Description: An Insightly Event Object

Properties:
Name Type Summary
EVENT_ID integer(int32) Event Id
Event Id
TITLE string Event Title
Title
START_DATE_UTC string Event Start Date
Start Date
END_DATE_UTC string Event End Date
End Date
DATE_CREATED_UTC string Event Create Date
Create Date
DATE_UPDATED_UTC string Event Update Date
Update Date
OWNER_USER_ID integer(int32) Event Owner User Id
Owner User Id
REMINDER_SENT boolean Reminder Sent
Is Reminder Sent
ALL_DAY boolean All Day Event
All Day Event
PUBLICLY_VISIBLE boolean Event Visibility
Event Visibility
EVENTLINKS array of (EventLink) Event Links
Event

1054 | P a g e
 Insightly

EventLink
Summary:
Description: An Insightly Event Link Object

Properties:
Name Type Summary
EVENT_LINK_ID integer(int32) Event Link Id
Link Id
CONTACT_ID integer(int32) The Contact Id
Contact Id
OPPORTUNITY_ID integer(int32) Opportunity Id
Opportunity Id
ORGANISATION_ID integer(int32) Organization Id
Organization Id
PROJECT_ID integer(int32) Project Id
Project Id
LEAD_ID integer(int32) Lead Id
Lead Id

1055 | P a g e
 Insightly

Lead
Summary:
Description: An Insightly Lead Object

Properties:
Name Type Summary
LEAD_ID integer(int32) The Lead Id
Lead Id
SALUTATION string Salutation
Salutation
TITLE string Lead Title
Title
FIRST_NAME string First Name
First Name
LAST_NAME string Last Name
Last Name
LEAD_DESCRIPTION string Lead Description
Lead Description
DATE_CREATED_UTC string Date Created
Date Created
DATE_UPDATED_UTC string Date Updated
Date Updated
CONVERTED_DATE_UTC string Date Converted
Date Converted
LEAD_STATUS_ID integer(int32) The Lead Status Id
Lead Status Id
VISIBLE_TO string Lead Visibility
Lead Visibility
ORGANIZATION_NAME string Organization Name

1056 | P a g e
 Insightly

Organization Name
PHONE_NUMBER string Phone Number
Phone Number
MOBILE_PHONE_NUMBER string Mobile Phone Number
Mobile Phone Number
EMAIL_ADDRESS string Email Address
Email Address
CONVERTED boolean Converted
Converted
WEBSITE_URL string Website Url
Website Url
OWNER_USER_ID integer(int32) Lead Owner
Lead Owner
RESPONSIBLE_USER_ID integer(int32) Lead Responsible
Lead Responsible
EMPLOYEE_COUNT integer(int32) Lead Employee Count
Lead Employee Count
LEAD_RATING integer(int32) Lead Rating
Lead Rating
INDUSTRY string Industry
Industry
ADDRESS_STREET string Address Street
Address Street
ADDRESS_CITY string Address City
Address City
ADDRESS_STATE string Address State
Address State
ADDRESS_POSTCODE string Address PostCode
Address PostCode

1057 | P a g e
 Insightly

ADDRESS_COUNTRY string Address Country

Address Country
TAGS array of (Tag) Tags
Tags

1058 | P a g e
 Insightly

LeadRequest
Summary:
Description: An Insightly LeadRequest Object

Properties:
Name Type Summary
TITLE string Lead Title
Title
FIRST_NAME string First Name
First Name
LAST_NAME string Last Name
Last Name
LEAD_DESCRIPTION string Lead Description
Lead Description
CONVERTED_DATE_UTC string Date Converted
Date Converted
VISIBLE_TO string Lead Visibility Values:
Lead Visibility [Everyone, Individuals,
Owner, Team]
VISIBLE_TEAM_ID integer(int32) Visible Team ID
Visible Team ID (Required when team
visibility state is selected)
VISIBLE_USER_IDS integer(int32) Visible User IDs
Visible User IDs (Required when
indivdiuals visibility state
is selected)
ORGANIZATION_NAME string Organization Name
Organization Name
PHONE_NUMBER string Phone Number

1059 | P a g e
 Insightly

Phone Number
MOBILE_PHONE_NUMBER string Mobile Phone Number
Mobile Phone Number
EMAIL_ADDRESS string Email Address
Email Address
CONVERTED boolean Converted
Converted
WEBSITE_URL string Website Url
Website Url
OWNER_USER_ID integer(int32) Lead Owner
Lead Owner
RESPONSIBLE_USER_ID integer(int32) Lead Responsible
Lead Responsible
EMPLOYEE_COUNT integer(int32) Lead Employee Count
Lead Employee Count
LEAD_RATING integer(int32) Lead Rating
Lead Rating
INDUSTRY string Industry
Industry
TAGS array of (Tag) Tag
Tag

1060 | P a g e
 Insightly

Link
Summary:
Description: An Insightly Contact Link Object

Properties:
Name Type Summary
LINK_ID integer(int32) Link Id
Link Id
CONTACT_ID integer(int32) The Contact Id
Contact Id
OPPORTUNITY_ID integer(int32) Opportunity Id
Opportunity Id
ORGANISATION_ID integer(int32) Organization Id
Organization Id
PROJECT_ID integer(int32) Project Id
Project Id
SECOND_PROJECT_ID integer(int32) Second Project Id
Second Project Id
SECOND_OPPORTUNITY_ID integer(int32) Second Opportunity Id
Second Opportunity Id
ROLE string Role
Role
DETAILS string Details
Details

1061 | P a g e
 Insightly

ListContactsResponse
Summary:
Description: A Insightly contact response object

Properties:
Name Type Summary
contacts array of (Contact) A collection of contacts
Contacts

1062 | P a g e
 Insightly

ListEventsResponse
Summary:
Description: A Insightly Event response object

Properties:
Name Type Summary
events array of (Event) A collection of events
Events

1063 | P a g e
 Insightly

ListLeadsResponse
Summary:
Description: A Insightly Lead response object

Properties:
Name Type Summary
leads array of (Lead) A collection of leads
Leads

1064 | P a g e
 Insightly

ListProjectsResponse
Summary:
Description: A Insightly Project response object

Properties:
Name Type Summary
projects array of (Project) A collection of projects
Projects

1065 | P a g e
 Insightly

ListTasksResponse
Summary:
Description: A Insightly Tasks response object

Properties:
Name Type Summary
tasks array of (Task) A collection of tasks
Tasks

1066 | P a g e
 Insightly

ListUsersResponse
Summary:
Description: A Insightly User response object

Properties:
Name Type Summary
users array of (User) A collection of users
Users

1067 | P a g e
 Insightly

Object
Summary:
Description:

Properties:
Name Type Summary

1068 | P a g e
 Insightly

Organization
Summary:
Description: An Insightly Organization Object

Properties:
Name Type Summary
ORGANISATION_ID integer(int32) Organization Id
Organization Id
ORGANISATION_BACKGROUND string Organization
Organization Background
Background
ORGANISATION_NAME string Organization Name
Organization Name
DATE_CREATED_UTC string Created Date of
Created Date Organization
DATE_UPDATED_UTC string Updated Date of
Updated Date Organization
OWNER_USER_ID integer(int32) Organization Owner
Organization Owner
VISIBLE_TO string Organization Visibility
Organization Visibility
ADDRESSES array of (Address) Organization Addresses
Organization
CONTACTINFOS array of (ContactInfo) Contact Information
Contact Information
LINKS array of (Link) Organization Links
Organization
TAGS array of (Tag) Tags
Tags

1069 | P a g e
 Insightly

1070 | P a g e
 Insightly

OrganizationRequest
Summary:
Description: An Insightly Organization Request Object

Properties:
Name Type Summary
ORGANISATION_NAME string Organization Name
Organization Name
ORGANISATION_BACKGROUND string Organization
Organization Background
Background
VISIBLE_TO string Organization Visibility
Organization Visibility Values: [Everyone,
Individuals, Owner,
Team]
VISIBLE_TEAM_ID integer(int32) Visible Team ID
Visible Team ID (Required when team
visibility state is
selected)
VISIBLE_USER_IDS integer(int32) Visible User IDs
Visible User IDs (Required when
indivdiuals visibility
state is selected)
ADDRESSES array of (Address) Organization Addresses
Organization Address
CONTACTINFOS array of (ContactInfo) Contact Information
Contact Information
TAGS array of (Tag) Tags
Tags

1071 | P a g e
 Insightly

1072 | P a g e
 Insightly

Project
Summary:
Description: An Insightly Project Object

Properties:
Name Type Summary
PROJECT_ID integer(int32) The Project Id
Project Id
PROJECT_NAME string Project Name
Project Name
STATUS string Project Status
Project Status
PROJECT_DETAILS string Project Details
Project Details
IMAGE_URL string Project Image URL
Image URL
DATE_CREATED_UTC string Date Created
Date Created
VISIBLE_TO string Project Visibility
Project Visibility
DATE_UPDATED_UTC string Date Updated
Date Updated
STARTED_DATE string Date Started
Date Started
COMPLETED_DATE string Date Completed
Date Completed
OWNER_USER_ID integer(int32) Project Owner
Project Owner
RESPONSIBLE_USER_ID integer(int32) Assigned To

1073 | P a g e
 Insightly

Assigned To
OPPORTUNITY_ID integer(int32) Opportunity Id
Opportunity Id
PIPELINE_ID integer(int32) Pipeline Id
Pipeline Id
STAGE_ID integer(int32) Stage Id
Stage Id
TAGS array of (Tag) Tags
Tags
LINKS array of (Link) Project Links
Project

1074 | P a g e
 Insightly

ProjectRequest
Summary:
Description: An Insightly Project Object

Properties:
Name Type Summary
PROJECT_NAME string Project Name
Project Name
PROJECT_DETAILS string Project Details
Project Details
STATUS string Project Status Values:
Project Status [Completed, Deferred, In
Progress, Not Started,
Abandoned, Cancelled]
IMAGE_URL string Project Image URL
Image URL
VISIBLE_TO string Project Visibility Values:
Project Visibility [Everyone, Individuals,
Owner, Team]
VISIBLE_TEAM_ID integer(int32) Visible Team ID (Required
Visible Team ID when team visibility state
is selected)
VISIBLE_USER_IDS integer(int32) Visible User IDs (Required
Visible User IDs when indivdiuals visibility
state is selected)
OPPORTUNITY_ID integer(int32) Opportunity Id
Opportunity Id
PIPELINE_ID integer(int32) Pipeline Id
Pipeline Id

1075 | P a g e
 Insightly

STAGE_ID integer(int32) Stage Id

Stage Id
TAGS array of (Tag) Tags
Tags

1076 | P a g e
 Insightly

Tag
Summary:
Description: A Tag Object

Properties:
Name Type Summary
TAG_NAME string Tag Name
Name

1077 | P a g e
 Insightly

Task
Summary:
Description: An Insightly Task Object

Properties:
Name Type Summary
TASK_ID integer(int32) The Task Id
Task Id
TITLE string The title of the task
Task Title
DUE_DATE string Due Date of a task
Due Date
CATEGORY_ID integer(int32) Category Id of a task
Category Id
COMPLETED_DATE_UTC string Completed Date of a task
Completed Date
COMPLETED boolean Is task completed
Completed
DETAILS string Task Details
Task Details
STATUS string Task Status Values:
Task Status [Completed, Deferred, In
Progress, Not Started,
Waiting]
PRIORITY string Task Priority
Task Priority
START_DATE string Start Date of a task
Start Date
PROJECT_ID integer(int32) Project Id

1078 | P a g e
 Insightly

Project Id
OPPORTUNITY_ID integer(int32) Opportunity Id
Opportunity Id
MILESTONE_ID integer(int32) Milestone Id
Milestone Id
PIPELINE_ID integer(int32) Pipeline Id
Pipeline Id
STAGE_ID integer(int32) Stage Id
Stage Id
PERCENT_COMPLETE integer(int32) Percentage Complete
Percentage Complete
OWNER_USER_ID integer(int32) Task Owner
Task Owner
RESPONSIBLE_USER_ID integer(int32) Assigned To
Assigned To
PUBLICLY_VISIBLE boolean Is task publicly visible
Task Visibility
DATE_CREATED_UTC string Created Date of a task
Created Date
DATE_UPDATED_UTC string Updated Date of a task
Updated Date
TASKLINKS array of (TaskLink) Task Links
Task

1079 | P a g e
 Insightly

TaskLink
Summary:
Description: An Insightly Task Link Object

Properties:
Name Type Summary
TASK_LINK_ID integer(int32) Task Link Id
Link Id
CONTACT_ID integer(int32) The Contact Id
Contact Id
OPPORTUNITY_ID integer(int32) Opportunity Id
Opportunity Id
ORGANISATION_ID integer(int32) Organization Id
Organization Id
PROJECT_ID integer(int32) Project Id
Project Id
LEAD_ID integer(int32) Lead Id
Lead Id

1080 | P a g e
 Insightly

TaskRequest
Summary:
Description: An Insightly Task Request Object

Properties:
Name Type Summary
TITLE string The title of the task
Task Title
DUE_DATE string Due Date of a task
Due Date
COMPLETED boolean Is task completed
Completed
DETAILS string Task Details
Task Details
STATUS string Task Status Values:
Task Status [Completed, Deferred, In
Progress, Not Started,
Waiting]
PRIORITY integer(int32) Task Priority
Task Priority
PUBLICLY_VISIBLE boolean Is task publicly visible
Publicly Visible

1081 | P a g e
 Insightly

User
Summary:
Description: An Insightly User Object

Properties:
Name Type Summary
USER_ID integer(int32) The User Id
User Id
CONTACT_ID integer(int32) The Contact Id
Contact Id
FIRST_NAME string First Name
First Name
LAST_NAME string Email Address
Last Name
EMAIL_ADDRESS string Email Address
Email Address

1082 | P a g e
 Instagram

Instagram
Instagram is an online service for sharing pictures with friends and family.
Connect to Instagram API to read photo streams on your Instagram account.

Status: Production Tier: Standard Version: 1.0

Actions:
Name Summary
SearchUsers (string q, Search users
[advanced][Optional]integer
count)
GetMyInfo () Get my profile
GetUserInfo (string user-id) Get user info
GetMyMedia Get my recent media
([Optional]number count,
[advanced][Optional]string
max_id,
[advanced][Optional]string
min_id)
GetUserMedia (string user-id, Get user recent media
[Optional]number count,
[advanced][Optional]string
max_id,
[advanced][Optional]string
min_id)
GetMyLikes () Get my likes
GetUserFollows (string user- Get user follows
id)

1083 | P a g e
 Instagram

GetUserFollowedBy (string Get user followed-by

user-id)
GetSelfRequestedBy () Get self requested-by
GetUserRelationship (string Get user relationship
user-id)
UpdateUserRelation (string Update user relationship
user-id,
PostRelationshipRequest
action)
SearchMedia (number lng, Search media in a given area
number lat, [Optional]integer
distance,
[advanced][Optional]string
min_timestamp,
[advanced][Optional]string
max_timestamp)
GetMedia (string media-id) Get media info
GetShortcodeMedia (string Get media by shortcode
shortcode)
GetMediaComments (string Get comments for media
media-id)
PostMediaComments (string Post media comments
media-id,
PostCommentRequest
comment)
DeleteMediaComments Delete media comment
(string media-id, string
comment-id)

1084 | P a g e
 Instagram

GetMediaLikes (string media- Get likes for media

id)
LikeMedia (string media-id) Like media
UnlikeMedia (string media-id) Delete the like on the media
SearchTags (string q) Search tags
GetTag (string tag-name) Get tag
GetTaggedMedia (string tag- Get tagged media
name, [Optional]number
count,
[advanced][Optional]integer
max_tag_id,
[advanced][Optional]integer
min_tag_id)
SearchLocation Search locations
([Optional]integer distance,
[Optional]string
facebook_places_id,
[Optional]string
foursquare_v2_id,
[Optional]number lng,
[Optional]number lat)
GetLocation (string location- Get location by id
id)
GetLocationMedia (string Get media by location
location-id,
[advanced][Optional]integer
max_timestamp,
[advanced][Optional]integer
min_timestamp,

1085 | P a g e
 Instagram

[advanced][Optional]string
max_id,
[advanced][Optional]string
min_id)

Triggers:
Name Summary
OnNewTaggedMedia (string When a new tagged media is posted
tag-name)
OnMyNewMedia () When I upload a new media

Objects:
Name Summary
CaptionItem
CommentItem
CommentsResponse
CountsItem
DetailedUserItem
ImageItem
LocationItem
LocationResponse
LocationsResponse
MediaItem
MediaResponse
MediasResponse
PostCommentRequest
PostRelationshipRequest
RelationItem

1086 | P a g e
 Instagram

RelationResponse
ResolutionItem
TagItem
TagResponse
TagsResponse
UserItem
UserReponse
UsersReponse

Actions:
SearchUsers
Summary: Search users
Description: Search for users based on a string query

Syntax:
Instagram.SearchUsers (string q, [advanced][Optional]integer
count)

Parameters:
Name Type Summary Required Related
Action
q string Specify a query True
(Specify a to retrieve
query to Users.
retrieve
Users.)

1087 | P a g e
 Instagram

count integer(int32) Specify the False

(Maximum number of Users
Results) to return.

Returns:
Type:UsersReponse

GetMyInfo
Summary: Get my profile
Description: Get detailed information about a User based on a username

Syntax:
Instagram.GetMyInfo ()

Returns:
Type:UserReponse

GetUserInfo
Summary: Get user info
Description: Get detailed information about a User based on a username

Syntax:
Instagram.GetUserInfo (string user-id)

Parameters:
Name Type Summary Required Related
Action

1088 | P a g e
 Instagram

user-id string Specify the ID to True

(User Id) retreive a User.

Returns:
Type:UserReponse

GetMyMedia
Summary: Get my recent media
Description: Gets recent media posted by the logged in user

Syntax:
Instagram.GetMyMedia ([Optional]number count,
[advanced][Optional]string max_id, [advanced][Optional]string
min_id)

Parameters:
Name Type Summary Required Related
Action
count number(double) Limit on the False
(Limit on the number of
number of media objects
media objects to be retrieved
to be retrieved (default, max =
(default, max = 100)
100))
max_id string Return media False
(Return media earlier than this
earlier than this max Id
max Id)

1089 | P a g e
 Instagram

min_id string Return media False

(Return media earlier than this
earlier than this min Id
min Id)

Returns:
Type:MediasResponse

GetUserMedia
Summary: Get user recent media
Description: Gets recent user media based on a username

Syntax:
Instagram.GetUserMedia (string user-id, [Optional]number count,
[advanced][Optional]string max_id, [advanced][Optional]string
min_id)

Parameters:
Name Type Summary Required Related
Action
user-id string Unique ID of True
(Unique ID of the user
the user)
count number(double) Limit on the False
(Limit on the number of
number of media objects
media objects to be retrieved
to be retrieved (default, max =
100)

1090 | P a g e
 Instagram

(default, max =
100))
max_id string Return media False
(Return media earlier than this
earlier than this max Id
max Id)
min_id string Return media False
(Return media earlier than this
earlier than this min Id
min Id)

Returns:
Type:MediasResponse

GetMyLikes
Summary: Get my likes
Description: Get the list of recent media liked by the logged in user.

Syntax:
Instagram.GetMyLikes ()

Returns:
Type:MediasResponse

GetUserFollows
Summary: Get user follows
Description: Gets the list of follows for a user based on a username

Syntax:

1091 | P a g e
 Instagram

Instagram.GetUserFollows (string user-id)

Parameters:
Name Type Summary Required Related
Action
user-id string Specify the ID to True
(User Id) retreive a User.

Returns:
Type:UsersReponse

GetUserFollowedBy
Summary: Get user followed-by
Description: Gets the list of followers for a user based on a username

Syntax:
Instagram.GetUserFollowedBy (string user-id)

Parameters:
Name Type Summary Required Related
Action
user-id string Specify the ID to True
(Specify the retreive a User.
ID to
retreive a
User.)

Returns:
Type:UsersReponse

1092 | P a g e
 Instagram

GetSelfRequestedBy
Summary: Get self requested-by
Description: Gets the list of users who have requested this user's permission to follow

Syntax:
Instagram.GetSelfRequestedBy ()

Returns:
Type:UsersReponse

GetUserRelationship
Summary: Get user relationship
Description: Gets the relationship between the current authenticated user and a
desired user

Syntax:
Instagram.GetUserRelationship (string user-id)

Parameters:
Name Type Summary Required Related
Action
user-id string Specify the ID to True
(Specify a retreive a User.
query to
retrieve
Users.)

Returns:

1093 | P a g e
 Instagram

Type:RelationResponse

UpdateUserRelation
Summary: Update user relationship
Description: Modify the relationship between the current user and the target user.

Syntax:
Instagram.UpdateUserRelation (string user-id,
PostRelationshipRequest action)

Parameters:
Name Type Summary Required Related
Action
user-id string Specify the ID True
(Specify a query to to retreive a
retrieve Users.) User.
action PostRelationshipRequest True

Returns:
Type:RelationResponse

SearchMedia
Summary: Search media in a given area
Description: Gets all media within the given distance of the given latitude and
longitude

Syntax:

1094 | P a g e
 Instagram

Instagram.SearchMedia (number lng, number lat, [Optional]integer

distance, [advanced][Optional]string min_timestamp,
[advanced][Optional]string max_timestamp)

Parameters:
Name Type Summary Required Related
Action
lng number(double) Longitude from True
(Longitude from which to search
which to
search)
lat number(double) Latitude from True
(Latitude from which to search
which to
search)
distance integer(int32) Distance from False
(Distance from which to search
which to search from given
from given latitude and
latitude and longitude
longitude)
min_timestamp string Returns all False
(Returns all media after the
media after the given
given timestamp
timestamp)
max_timestamp string Returns all False
(Returns all media before
media before

1095 | P a g e
 Instagram

the given the given

timestamp) timestamp

Returns:
Type:MediasResponse

GetMedia
Summary: Get media info
Description: Get information about a media

Syntax:
Instagram.GetMedia (string media-id)

Parameters:
Name Type Summary Required Related
Action
media-id string The ID of the True
(Media Id) media to fetch.

Returns:
Type:MediaResponse

GetShortcodeMedia
Summary: Get media by shortcode
Description: Get information about a media through a short code. A media object's
shortcode can be found in its shortlink URL. An example shortlink is
http://instagram.com/p/tsxp1hhQTG/. Its corresponding shortcode is tsxp1hhQTG.

Syntax:

1096 | P a g e
 Instagram

Instagram.GetShortcodeMedia (string shortcode)

Parameters:
Name Type Summary Required Related
Action
shortcode string The media True
(Media shortcode to
shortcode) fetch the media
by.

Returns:
Type:MediaItem

GetMediaComments
Summary: Get comments for media
Description: Gets the list of comments on a media object

Syntax:
Instagram.GetMediaComments (string media-id)

Parameters:
Name Type Summary Required Related
Action
media-id string Specify the True
(Media id) media to fetch
the comments

Returns:
Type:CommentsResponse

1097 | P a g e
 Instagram

PostMediaComments
Summary: Post media comments
Description: Post a comment to the

Syntax:
Instagram.PostMediaComments (string media-id, PostCommentRequest
comment)

Parameters:
Name Type Summary Required Related
Action
media-id string Specify the ID True
(Specify an ID to to retreive a
retrieve Media.) Media.
comment PostCommentRequest True

Returns:

DeleteMediaComments
Summary: Delete media comment
Description: Delete the Media Comment

Syntax:
Instagram.DeleteMediaComments (string media-id, string comment-
id)

Parameters:

1098 | P a g e
 Instagram

Name Type Summary Required Related

Action
media-id string Specify the ID to True
(Specify an retreive a Media.
ID to
retrieve
Media.)
comment-id string Specify the ID to True
(Specify an retreive a
ID to comment.
retrieve
comment.)

Returns:

GetMediaLikes
Summary: Get likes for media
Description: Gets the list of users who have liked a media object

Syntax:
Instagram.GetMediaLikes (string media-id)

Parameters:
Name Type Summary Required Related
Action
media-id string Specify the True
(Media id) media ID to fetch
the likes

1099 | P a g e
 Instagram

Returns:
Type:UsersReponse

LikeMedia
Summary: Like media
Description: Set a like on this media by the currently authenticated user.

Syntax:
Instagram.LikeMedia (string media-id)

Parameters:
Name Type Summary Required Related
Action
media-id string Specify the ID to True
(Specify an retreive a Media.
ID to
retrieve
Media.)

Returns:

UnlikeMedia
Summary: Delete the like on the media
Description: Remove a like on this media by the currently authenticated user.

Syntax:
Instagram.UnlikeMedia (string media-id)

Parameters:

1100 | P a g e
 Instagram

Name Type Summary Required Related

Action
media-id string Specify the ID to True
(Specify an retreive a Media.
ID to
retrieve
Media.)

Returns:

SearchTags
Summary: Search tags
Description: Search for tags based on a string query

Syntax:
Instagram.SearchTags (string q)

Parameters:
Name Type Summary Required Related
Action
q string Specify a query True
(Specify a to retrieve Tags.
query to
retrieve
Tags.)

Returns:
Type:TagsResponse

1101 | P a g e
 Instagram

GetTag
Summary: Get tag
Description: Get Tag Details based on the tag name

Syntax:
Instagram.GetTag (string tag-name)

Parameters:
Name Type Summary Required Related
Action
tag-name string Specify a name True
(Specify a to retrieve Tag.
name to
retrieve
Tag.)

Returns:
Type:TagResponse

GetTaggedMedia
Summary: Get tagged media
Description: Gets recent tagged media based on a tag name

Syntax:
Instagram.GetTaggedMedia (string tag-name, [Optional]number
count, [advanced][Optional]integer max_tag_id,
[advanced][Optional]integer min_tag_id)

Parameters:

1102 | P a g e
 Instagram

Name Type Summary Required Related

Action
tag-name string Name of the True
(Name of the desired tag
desired tag)
count number(double) Limit on the False
(Limit on the number of
number of media objects
media objects to be retrieved
to be retrieved (default, max =
(default, max = 100)
100))
max_tag_id integer(int64) Return media False
(Return media earlier than this
earlier than this max_tag_id
max_tag_id)
min_tag_id integer(int64) Return media False
(Return media earlier than this
earlier than this min_tag_id
min_tag_id)

Returns:
Type:MediasResponse

SearchLocation
Summary: Search locations
Description: Gets all locations within the given distance of the given latitude and
longitude

1103 | P a g e
 Instagram

Syntax:
Instagram.SearchLocation ([Optional]integer distance,
[Optional]string facebook_places_id, [Optional]string
foursquare_v2_id, [Optional]number lng, [Optional]number lat)

Parameters:
Name Type Summary Required Related
Action
distance integer(int32) Distance from False
(Distance from which to
which to search search from
from given given latitude
latitude and and longitude
longitude)
facebook_places_id string Location False
(Facebook mapped off of
Places Id) a Facebook
places id
foursquare_v2_id string Location False
(Location mapped off a
mapped off of a foursquare v2
Facebook api location id
places id)
lng number(double) Longitude from False
(Longitude from which to
which to search
search)

1104 | P a g e
 Instagram

lat number(double) Latitude from False

(Latitude from which to
which to search
search)

Returns:
Type:LocationsResponse

GetLocation
Summary: Get location by id
Description: Gets all locations within the given distance of the given latitude and
longitude

Syntax:
Instagram.GetLocation (string location-id)

Parameters:
Name Type Summary Required Related
Action
location-id string The ID of the True
(Location Location Object
Id) that is to be
fetched.

Returns:
Type:LocationResponse

GetLocationMedia
Summary: Get media by location

1105 | P a g e
 Instagram

Description: Gets recent media posted in the given location

Syntax:
Instagram.GetLocationMedia (string location-id,
[advanced][Optional]integer max_timestamp,
[advanced][Optional]integer min_timestamp,
[advanced][Optional]string max_id, [advanced][Optional]string
min_id)

Parameters:
Name Type Summary Required Related
Action
location-id string Unique ID of the True
(Unique ID of location
the location)
max_timestamp integer(int64) Return media False
(Return before this
media before timestamp
this
timestamp)
min_timestamp integer(int64) Return media False
(Return after this
media after timestamp
this
timestamp)
max_id string Return media False
(Return earlier than this
media earlier max_id
than this
max_id)

1106 | P a g e
 Instagram

min_id string Return media False

(Return earlier than this
media earlier min_id
than this
min_id)

Returns:
Type:MediasResponse

Triggers:
Trigger OnNewTaggedMedia
Summary: When a new tagged media is posted
Description: Starts a flow when a new media is posted with a certain hashtag.

Syntax:
Instagram.OnNewTaggedMedia (string tag-name)

Parameters:
Name Type Summary Required Related
Action
tag-name string Name of the True
(Name of desired tag
the desired
tag)

Returns:
Type:MediasResponse

1107 | P a g e
 Instagram

Trigger OnMyNewMedia
Summary: When I upload a new media
Description: Starts a flow when a new media is posted on my feed.

Syntax:
Instagram.OnMyNewMedia ()

Returns:
Type:MediasResponse

1108 | P a g e
 Instagram

CaptionItem
Summary:
Description:

Properties:
Name Type Summary
text string Caption text on the media

created_time integer(int64) Unix time which the

caption is posted

1109 | P a g e
 Instagram

CommentItem
Summary:
Description:

Properties:
Name Type Summary
created_time string The time which the
comment is created
text string The text commented.

id string The unique ID for the

comment.
from UserItem

1110 | P a g e
 Instagram

CommentsResponse
Summary:
Description:

Properties:
Name Type Summary
data array of (CommentItem) The List of comment
objects returned

1111 | P a g e
 Instagram

CountsItem
Summary:
Description:

Properties:
Name Type Summary
media integer(int32) Media count for the User.

follows integer(int32) Following count for the

User.
followed_by integer(int32) Number of user who has
followed the user.

1112 | P a g e
 Instagram

DetailedUserItem
Summary:
Description:

Properties:
Name Type Summary
username string Username of the User

profile_picture string Profile picture of the User

full_name string Full name of the user

counts CountsItem

website string(uri) Url of the User's

instagram Page
bio string Bio of the user

id string ID of the user

1113 | P a g e
 Instagram

ImageItem
Summary:
Description:

Properties:
Name Type Summary
url string(uri) The url to an image on the
media in set resolution.
height integer(int32) The height of an image on
the media in set
resolution.
width integer(int32) The width of an image on
the media in set
resolution.

1114 | P a g e
 Instagram

LocationItem
Summary:
Description:

Properties:
Name Type Summary
longitude number(double) The longitude value of the
location.
latitude number(double) The latitude value of the
location.
name string Name of the location.

id string The unique ID of the

Location id location.

1115 | P a g e
 Instagram

LocationResponse
Summary:
Description:

Properties:
Name Type Summary
data LocationItem

1116 | P a g e
 Instagram

LocationsResponse
Summary:
Description:

Properties:
Name Type Summary
data array of (LocationItem) The List of Location
Objects returned.

1117 | P a g e
 Instagram

MediaItem
Summary:
Description:

Properties:
Name Type Summary
images ResolutionItem

user UserItem

link string(uri) Link to the media

created_time integer(int64) Unix time which the

media is created
id string Unique ID for the media

caption CaptionItem

tags array of (TagItem) Tags put on the media

filter string Filtered media

1118 | P a g e
 Instagram

MediaResponse
Summary:
Description:

Properties:
Name Type Summary
data MediaItem

1119 | P a g e
 Instagram

MediasResponse
Summary:
Description:

Properties:
Name Type Summary
data array of (MediaItem) The list of media items
returned.

1120 | P a g e
 Instagram

PostCommentRequest
Summary:
Description:

Properties:
Name Type Summary
text string The text message of the
comment to post.

1121 | P a g e
 Instagram

PostRelationshipRequest
Summary:
Description:

Properties:
Name Type Summary
action string Specify the relationship
action you want to
perform Values: [follow,
unfollow, approve, ignore]

1122 | P a g e
 Instagram

RelationItem
Summary:
Description:

Properties:
Name Type Summary
incoming_status string Incoming relationship
status.
outgoing_status string Outgoing relationship
status.

1123 | P a g e
 Instagram

RelationResponse
Summary:
Description:

Properties:
Name Type Summary
data RelationItem

1124 | P a g e
 Instagram

ResolutionItem
Summary:
Description:

Properties:
Name Type Summary
standard_resolution ImageItem

1125 | P a g e
 Instagram

TagItem
Summary:
Description:

Properties:
Name Type Summary
media_count integer(int32) Number of media items
with the tag.
name string Name of the tag.

1126 | P a g e
 Instagram

TagResponse
Summary:
Description:

Properties:
Name Type Summary
data TagItem

1127 | P a g e
 Instagram

TagsResponse
Summary:
Description:

Properties:
Name Type Summary
data array of (TagItem) The List of Tag Objects
returned.

1128 | P a g e
 Instagram

UserItem
Summary:
Description:

Properties:
Name Type Summary
username string Username of the user

profile_picture string Profile picture of the user

first_name string First name of the user

last_name string Last name of the user

full_name string Full name of the user

id string Instagram ID of the user

1129 | P a g e
 Instagram

UserReponse
Summary:
Description:

Properties:
Name Type Summary
data DetailedUserItem

1130 | P a g e
 Instagram

UsersReponse
Summary:
Description:

Properties:
Name Type Summary
data array of (DetailedUserItem) The List of users returned.

1131 | P a g e
 Instapaper

Instapaper
Instapaper is a tool for saving web pages to read later. You can create reading
lists by organizing pages into folders which can then be accessed from any
mobile or web client.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
ListBookmarksLiked Get all liked bookmarks
([Optional]ReadFilterEnum
readFilter)
ListBookmarksArchived Get all archived bookmarks
([Optional]ReadAndLikedFilterEnum
filters)
ListBookmarksInFolder (string Get bookmarks in a folder
folder_id,
[advanced][Optional]string
likedFilter,
[advanced][Optional]string
readFilter)
ListFolders () Get folders
ListHighlights (string bookmark_id)
UnlikeBookmark (string Unlike a bookmark
bookmark_id)
LikeBookmark (string bookmark_id) Like a bookmark
ArchiveBookmark (string Archive a bookmark
bookmark_id)

1132 | P a g e
 Instapaper

UnarchiveBookmark (string Unarchive a bookmark

bookmark_id)
DeleteBookmark (string Delete a bookmark permenantly (warning:
bookmark_id) can not be undone)
MarkReadBookmark (string Mark a bookmark read
bookmark_id)
MarkUnreadBookmark (string Mark a bookmark unread
bookmark_id)
AddHighlight (string bookmark_Id, Add a highlight to a bookmark
string text)
CreateFolder (string title) Create a folder

Triggers:
Name Summary
OnBookmarkAdded (string When a bookmark is added to a folder
folder_id)
OnBookmarkRemoved (string When a bookmark is removed from a folder
folder_id)
OnBookmarkArchived () When a bookmark is archived
OnBookmarkLiked () When a bookmark is liked
OnFolderCreated () When a folder is created
OnBookmarkProgressUpdated When the read progress of a bookmark is updated
(string folder_id)
OnBookmarkProgressRead When a bookmark is marked read
(string folder_id)
OnHighlightAdded (string When a highlight is added to a bookmark
folder_id, string
bookmark_id)

1133 | P a g e
 Instapaper

Objects:
Name Summary
Bookmark
BookmarkResponse
BookmarksResponse
Folder
FolderResponse
FoldersResponse
HighlighstResponse
Highlight
HighlightResponse
Object
ReadAndLikedFilterEnum
ReadFilterEnum

Actions:
ListBookmarksLiked
Summary: Get all liked bookmarks
Description: Get all liked bookmarks

Syntax:
Instapaper.ListBookmarksLiked ([Optional]ReadFilterEnum
readFilter)

Parameters:
Name Type Summary Required Related
Action
readFilter ReadFilterEnum False

1134 | P a g e
 Instapaper

Returns:
Type:BookmarksResponse
Description: The response model for bookmark searches

ListBookmarksArchived
Summary: Get all archived bookmarks
Description: Get all archived bookmarks

Syntax:
Instapaper.ListBookmarksArchived
([Optional]ReadAndLikedFilterEnum filters)

Parameters:
Name Type Summary Required Related
Action
filters ReadAndLikedFilterEnum False

Returns:
Type:BookmarksResponse
Description: The response model for bookmark searches

ListBookmarksInFolder
Summary: Get bookmarks in a folder
Description: Get bookmarks in a folder

Syntax:

1135 | P a g e
 Instapaper

Instapaper.ListBookmarksInFolder (string folder_id,

[advanced][Optional]string likedFilter,
[advanced][Optional]string readFilter)

Parameters:
Name Type Summary Required Related
Action
folder_id string The folder id, or True ListFolders
(Folder) "unread" for the
home folder
likedFilter string Whether to filter False
(Liked filter on the "liked"
(default: feature of a
all))Values: bookmark
[Liked, Not
liked]
readFilter string Whether to filter False
(Read filter on the read
(default: progress of a
all))Values: bookmark
[Unread,
Unread or
partially
read,
Partially
read,
Partially
read or
read, Read]

1136 | P a g e
 Instapaper

Returns:
Type:BookmarksResponse
Description: The response model for bookmark searches

ListFolders
Summary: Get folders
Description: Get folders

Syntax:
Instapaper.ListFolders ()

Returns:
Type:FoldersResponse
Description: The resposne model for folder searches

ListHighlights
Summary:
Description:

Syntax:
Instapaper.ListHighlights (string bookmark_id)

Parameters:
Name Type Summary Required Related
Action
bookmark_id string True
(Bookmark
Id)

1137 | P a g e
 Instapaper

Returns:
Type:HighlighstResponse
Description: The response model for highlights actions

UnlikeBookmark
Summary: Unlike a bookmark
Description: Unlike a bookmark

Syntax:
Instapaper.UnlikeBookmark (string bookmark_id)

Parameters:
Name Type Summary Required Related
Action
bookmark_id string True
(Bookmark
Id)

Returns:
Type:BookmarkResponse
Description: The response model for bookark actions

LikeBookmark
Summary: Like a bookmark
Description: Like a bookmark

Syntax:
Instapaper.LikeBookmark (string bookmark_id)

1138 | P a g e
 Instapaper

Parameters:
Name Type Summary Required Related
Action
bookmark_id string True

Returns:
Type:BookmarkResponse
Description: The response model for bookark actions

ArchiveBookmark
Summary: Archive a bookmark
Description: Archive a bookmark

Syntax:
Instapaper.ArchiveBookmark (string bookmark_id)

Parameters:
Name Type Summary Required Related
Action
bookmark_id string Use an identifier True
(Bookmark) from a previous
step

Returns:
Type:BookmarkResponse
Description: The response model for bookark actions

1139 | P a g e
 Instapaper

UnarchiveBookmark
Summary: Unarchive a bookmark
Description: Unarchive a bookmark

Syntax:
Instapaper.UnarchiveBookmark (string bookmark_id)

Parameters:
Name Type Summary Required Related
Action
bookmark_id string True
(Bookmark)

Returns:
Type:BookmarkResponse
Description: The response model for bookark actions

DeleteBookmark
Summary: Delete a bookmark permenantly (warning: can not be undone)
Description: Delete a bookmark permenantly (warning: can not be undone)

Syntax:
Instapaper.DeleteBookmark (string bookmark_id)

Parameters:
Name Type Summary Required Related
Action
bookmark_id string True

1140 | P a g e
 Instapaper

(Bookmark
Id)

Returns:
Type:Object

MarkReadBookmark
Summary: Mark a bookmark read
Description: Mark a bookmark read

Syntax:
Instapaper.MarkReadBookmark (string bookmark_id)

Parameters:
Name Type Summary Required Related
Action
bookmark_id string True
(Bookmark
Id)

Returns:
Type:Object

MarkUnreadBookmark
Summary: Mark a bookmark unread
Description: Mark a bookmark unread

Syntax:
Instapaper.MarkUnreadBookmark (string bookmark_id)

1141 | P a g e
 Instapaper

Parameters:
Name Type Summary Required Related
Action
bookmark_id string True
(Bookmark
Id)

Returns:
Type:Object

AddHighlight
Summary: Add a highlight to a bookmark
Description: Add a highlight to a bookmark

Syntax:
Instapaper.AddHighlight (string bookmark_Id, string text)

Parameters:
Name Type Summary Required Related
Action
bookmark_Id string True
(Bookmark
Id)
text string The text to True
(Text) highlight

Returns:
Type:HighlightResponse

1142 | P a g e
 Instapaper

Description: The response model for highlight actions

CreateFolder
Summary: Create a folder
Description: Create a folder

Syntax:
Instapaper.CreateFolder (string title)

Parameters:
Name Type Summary Required Related
Action
title string The name of the True
(Name) new folder, must
be unique

Returns:
Type:FolderResponse
Description: The resposne model for folder searches

Triggers:
Trigger OnBookmarkAdded
Summary: When a bookmark is added to a folder
Description: When a bookmark is added to a folder

Syntax:
Instapaper.OnBookmarkAdded (string folder_id)

Parameters:
1143 | P a g e
 Instapaper

Name Type Summary Required Related

Action
folder_id string The folder id, or True ListFolders
(Folder) "unread" for the
home folder

Returns:
Type:BookmarksResponse
Description: The response model for bookmark searches

Trigger OnBookmarkRemoved
Summary: When a bookmark is removed from a folder
Description: When a bookmark is removed from a folder

Syntax:
Instapaper.OnBookmarkRemoved (string folder_id)

Parameters:
Name Type Summary Required Related
Action
folder_id string The folder id, or True ListFolders
(Folder) "unread" for the
home folder

Returns:
Type:array of (integer(int32))

Trigger OnBookmarkArchived
Summary: When a bookmark is archived

1144 | P a g e
 Instapaper

Description: When a bookmark is archived

Syntax:
Instapaper.OnBookmarkArchived ()

Returns:
Type:BookmarksResponse
Description: The response model for bookmark searches

Trigger OnBookmarkLiked
Summary: When a bookmark is liked
Description: When a bookmark is liked

Syntax:
Instapaper.OnBookmarkLiked ()

Returns:
Type:BookmarksResponse
Description: The response model for bookmark searches

Trigger OnFolderCreated
Summary: When a folder is created
Description: When a folder is created

Syntax:
Instapaper.OnFolderCreated ()

Returns:
Type:FoldersResponse

1145 | P a g e
 Instapaper

Description: The resposne model for folder searches

Trigger OnBookmarkProgressUpdated
Summary: When the read progress of a bookmark is updated
Description: When the read progress of a bookmark is updated

Syntax:
Instapaper.OnBookmarkProgressUpdated (string folder_id)

Parameters:
Name Type Summary Required Related
Action
folder_id string The folder id, or True ListFolders
(Folder) "unread" for the
home folder

Returns:
Type:BookmarksResponse
Description: The response model for bookmark searches

Trigger OnBookmarkProgressRead
Summary: When a bookmark is marked read
Description: When a bookmark is marked read

Syntax:
Instapaper.OnBookmarkProgressRead (string folder_id)

Parameters:

1146 | P a g e
 Instapaper

Name Type Summary Required Related

Action
folder_id string The folder id, or True ListFolders
(Folder) "unread" for the
home folder

Returns:
Type:BookmarksResponse
Description: The response model for bookmark searches

Trigger OnHighlightAdded
Summary: When a highlight is added to a bookmark
Description: When a highlight is added to a bookmark

Syntax:
Instapaper.OnHighlightAdded (string folder_id, string
bookmark_id)

Parameters:
Name Type Summary Required Related Action
folder_id string The folder to True ListFolders
(Folder) look a
bookmark
up in
bookmark_id string The True ListBookmarksInFolder
(Bookmark) bookmark to
check for
highlights

1147 | P a g e
 Instapaper

Returns:
Type:HighlighstResponse
Description: The response model for highlights actions

1148 | P a g e
 Instapaper

Bookmark
Summary:
Description: A user

Properties:
Name Type Summary
bookmark_id integer(int32) Identifier of the bookmark
Bookmark Id
title string Title of the bookmark
Title
description string
Description
url string The original url of the
Url bookmarked item
starred boolean Indicates whether the
Liked bookmark has been liked
or not
time string(date-time) The time the bookmark
Creation time was created
progress number(double) The percentage of the
Read progress bookmark that has been
read

1149 | P a g e
 Instapaper

BookmarkResponse
Summary:
Description: The response model for bookark actions

Properties:
Name Type Summary
Bookmark Bookmark A user

1150 | P a g e
 Instapaper

BookmarksResponse
Summary:
Description: The response model for bookmark searches

Properties:
Name Type Summary
Bookmarks array of (Bookmark) A list of bookmarks
returned by the action

1151 | P a g e
 Instapaper

Folder
Summary:
Description: A user

Properties:
Name Type Summary
folder_id integer(int32) Identifier of the folder
Folder Id
title string
Title
display_title string
Display title
sync_to_mobile boolean indicates whether this
Sync to mobile folder is synced to mobile
app
position integer(int32) Ordinal position of the
Position folder

1152 | P a g e
 Instapaper

FolderResponse
Summary:
Description: The resposne model for folder searches

Properties:
Name Type Summary
Folders Folder A user

1153 | P a g e
 Instapaper

FoldersResponse
Summary:
Description: The resposne model for folder searches

Properties:
Name Type Summary
Folders array of (Folder) A list of folders returned
by the action

1154 | P a g e
 Instapaper

HighlighstResponse
Summary:
Description: The response model for highlights actions

Properties:
Name Type Summary
Highlights array of (Highlight) The highlights

1155 | P a g e
 Instapaper

Highlight
Summary:
Description: A user

Properties:
Name Type Summary
highlight_id integer(int32)
Highlight Id
text string The text to highlight
Text
position integer(int32) Position where to start
Position searching for the text
time integer(int32) Time the highlight was
Creation time created

1156 | P a g e
 Instapaper

HighlightResponse
Summary:
Description: The response model for highlight actions

Properties:
Name Type Summary
Highlight Highlight A user

1157 | P a g e
 Instapaper

Object
Summary:
Description:

Properties:
Name Type Summary

1158 | P a g e
 Instapaper

ReadAndLikedFilterEnum
Summary:
Description:

Properties:
Name Type Summary
likedFilter string Whether to filter on the
Liked filter (default: all) "liked" feature of a
bookmark Values: [Liked,
Not liked]
readFilter string Whether to filter on the
Read filter (default: all) read progress of a
bookmark Values:
[Unread, Unread or
partially read, Partially
read, Partially read or
read, Read]

1159 | P a g e
 Instapaper

ReadFilterEnum
Summary:
Description:

Properties:
Name Type Summary
readFilter string

1160 | P a g e
 Intercom

Intercom
Intercom makes messaging apps for businesses that help them understand
and talk to consumers.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
ListUsers () List users
CreateUser Create or update user
(CreateUserParameterBody
body)
ListLeads () List all leads
CreateLead Create new lead
(CreateLeadParameterBody
body)
ListCompanies () List companies
GetUser (string user_id) Get user
GetLead (string contact_id) Get lead

Triggers:
Name Summary
TrigNewLead () When a lead is created
TrigNewUser () When a user is created
TrigUpdateUser () When a user is updated
TrigNewConversation () When a new conversation starts

1161 | P a g e
 Intercom

Objects:
Name Summary
CreateLeadParameterBody
CreateUserParameterBody
Lead_Response
ListCompanies_Response
TrigConversation_Response
TrigLead_Response
TrigUser_Response
User_Response

Actions:
ListUsers
Summary: List users
Description: List all users.

Syntax:
Intercom.ListUsers ()

Returns:
Type:array of (User_Response)

CreateUser
Summary: Create or update user
Description: Creates a new user for your Intercom account. Users found via email will
be updated.

Syntax:

1162 | P a g e
 Intercom

Intercom.CreateUser (CreateUserParameterBody body)

Parameters:
Name Type Summary Required Related
Action
body CreateUserParameterBody True

Returns:
Type:User_Response

ListLeads
Summary: List all leads
Description: Returns a list of all leads within your Intercom account.

Syntax:
Intercom.ListLeads ()

Returns:
Type:array of (Lead_Response)

CreateLead
Summary: Create new lead
Description: Creates a new lead for your Intercom account.

Syntax:
Intercom.CreateLead (CreateLeadParameterBody body)

Parameters:

1163 | P a g e
 Intercom

Name Type Summary Required Related

Action
body CreateLeadParameterBody True

Returns:
Type:Lead_Response

ListCompanies
Summary: List companies
Description: List all companies.

Syntax:
Intercom.ListCompanies ()

Returns:
Type:ListCompanies_Response

GetUser
Summary: Get user
Description: Given the id for an existing user, this operation returns all information
about the user.

Syntax:
Intercom.GetUser (string user_id)

Parameters:

1164 | P a g e
 Intercom

Name Type Summary Required Related

Action
user_id string True
(User Id)

Returns:
Type:User_Response

GetLead
Summary: Get lead
Description: Given the id for an existing lead, this operation returns all information
about the lead.

Syntax:
Intercom.GetLead (string contact_id)

Parameters:
Name Type Summary Required Related
Action
contact_id string True
(Lead Id)

Returns:
Type:Lead_Response

Triggers:
Trigger TrigNewLead
Summary: When a lead is created
Description: Triggers when a new lead is created.

1165 | P a g e
 Intercom

Syntax:
Intercom.TrigNewLead ()

Returns:
Type:array of (TrigLead_Response)

Trigger TrigNewUser
Summary: When a user is created
Description: Triggers when a new user is created.

Syntax:
Intercom.TrigNewUser ()

Returns:
Type:array of (TrigUser_Response)

Trigger TrigUpdateUser
Summary: When a user is updated
Description: Triggers when an existing user's information is updated.

Syntax:
Intercom.TrigUpdateUser ()

Returns:
Type:array of (TrigUser_Response)

Trigger TrigNewConversation
Summary: When a new conversation starts
1166 | P a g e
 Intercom

Description: Triggers when a user starts a new conversation.

Syntax:
Intercom.TrigNewConversation ()

Returns:
Type:array of (TrigConversation_Response)

1167 | P a g e
 Intercom

CreateLeadParameterBody
Summary:
Description:

Properties:
Name Type Summary
email string
Email
name string
Name
phone string
Phone
avatar Avatar
Avatar
companies string
Company Id

Avatar
Summary: Avatar
Description:

Properties:
Name Type Summary
image_url string
Image URL

1168 | P a g e
 Intercom

CreateUserParameterBody
Summary:
Description:

Properties:
Name Type Summary
email string
Email
name string
Name
phone string
Phone
companies string
Company Id

1169 | P a g e
 Intercom

Lead_Response
Summary:
Description:

Properties:
Name Type Summary
id string Intercom defined id
Id representing the lead.
created_at string yyyy-MM-
Created Date-Time ddTHH:mm:ss.fffZ
user_id string Unique identifier you
Lead Id have defined for the lead.
email string Lead's email.
Email
phone string Lead's phone number.
Phone
name string Lead's name.
Name
avatar Avatar

unsubscribed_from_emails boolean An avatar image URL,

Is Unsubscribed needs to be https.
location_data Location_data

Avatar
Summary:
Description:

1170 | P a g e
 Intercom

Properties:
Name Type Summary
image_url string An avatar image URL,
Image URL needs to be https.

Location_data
Summary:
Description:

Properties:
Name Type Summary
city_name string Location of the lead.
City Name
country_name string Location of the lead.
Country Name
latitude number Location of the lead.
Latitude
longitude number Location of the lead.
Longitude
postal_code string Location of the lead.
Postal Code
region_name string Location of the lead.
Region Name
timezone string ISO 8601 time zone for
Time Zone the lead's location.

1171 | P a g e
 Intercom

ListCompanies_Response
Summary:
Description:

Properties:
Name Type Summary
companies array of (CompaniesItem) companies
companies

CompaniesItem
Summary:
Description:

Properties:
Name Type Summary
company_id string company_id
company_id
id string id
id
name string name
name

1172 | P a g e
 Intercom

TrigConversation_Response
Summary:
Description:

Properties:
Name Type Summary
assignee Assignee assignee

conversation_message Conversation_message conversation_message

created_at string yyyy-MM-

Created Date Time ddTHH:mm:ss.fffZ
id string Conversation id.
Id
updated_at integer(int32) yyyy-MM-
Updated Date Time ddTHH:mm:ss.fffZ
user User user

Assignee
Summary:
Description: assignee

Properties:
Name Type Summary
id string User the conversation is
Admin Id currently assigned to.

1173 | P a g e
 Intercom

Conversation_message
Summary:
Description: conversation_message

Properties:
Name Type Summary
author Author

body string Body of the message.

Text
subject string Conversation subject.
Subject
url string URL of the conversation
Message URL message.

Author
Summary:
Description:

Properties:
Name Type Summary
id string Conversation author's id.
Author Id
type string Type of the author.
Author Type

User
Summary:
Description: user

1174 | P a g e
 Intercom

Properties:
Name Type Summary
id string Id of user the conversation
User Id concerns.
type string The user type.
User Type

1175 | P a g e
 Intercom

TrigLead_Response
Summary:
Description:

Properties:
Name Type Summary
id string Intercom defined id
Id representing the lead.
created_at string yyyy-MM-
Created Date-Time ddTHH:mm:ss.fffZ
user_id string Unique identifier you
User Id have defined for the user.
email string Lead's email.
Email
phone string Lead's phone number.
Phone
name string Lead's name.
Name
avatar Avatar

unsubscribed_from_emails boolean True if the lead is

Is Unsubscribed unsubscribed from
emails.
location_data Location_data

companies Companies

tags Tags

1176 | P a g e
 Intercom

Avatar
Summary:
Description:

Properties:
Name Type Summary
image_url string An avatar image URL,
Image URL needs to be https.

Location_data
Summary:
Description:

Properties:
Name Type Summary
city_name string Location of the lead.
City Name
country_name string Location of the lead.
Country Name
latitude number Location of the lead.
Latitude
longitude number Location of the lead.
Longitude
postal_code string Location of the lead.
Postal Code
region_name string Location of the lead.
Region Name

1177 | P a g e
 Intercom

timezone string ISO 8601 time zone for

Time Zone the lead's location.

Companies
Summary:
Description:

Properties:
Name Type Summary
companies array of (CompaniesItem) companies

CompaniesItem
Summary:
Description:

Properties:
Name Type Summary
name string Name of the company.
Company Name

Tags
Summary:
Description:

Properties:
Name Type Summary
companies array of (CompaniesItem) tags

1178 | P a g e
 Intercom

CompaniesItem
Summary:
Description:

Properties:
Name Type Summary
name string Name of the tag.
Tag Name

1179 | P a g e
 Intercom

TrigUser_Response
Summary:
Description:

Properties:
Name Type Summary
id string Intercom defined id
Id representing the user.
created_at string yyyy-MM-
Created Date-Time ddTHH:mm:ss.fffZ
user_id string Unique identifier you
User Id have defined for the user.
email string User's email.
Email
phone string User's phone number.
Phone
name string User's name.
Name
session_count integer Number of sessions the
Session Count user has recorded.
avatar Avatar

unsubscribed_from_emails boolean True if the user is

Is Unsubscribed unsubscribed from
emails.
location_data Location_data

1180 | P a g e
 Intercom

pseudonym string The pseudonym used if

Pseudonym this user was previously a
lead.
companies Companies

tags Tags

Avatar
Summary:
Description:

Properties:
Name Type Summary
image_url string An avatar image URL,
Image URL needs to be https.

Location_data
Summary:
Description:

Properties:
Name Type Summary
city_name string Location of the user.
City Name
country_name string Location of the user.
Country Name
latitude number Location of the user.
Latitude

1181 | P a g e
 Intercom

longitude number Location of the user.

Longitude
postal_code string Location of the user.
Postal Code
region_name string Location of the user.
Region Name
timezone string ISO 8601 time zone for
Time Zone the user's location.

Companies
Summary:
Description:

Properties:
Name Type Summary
companies array of (CompaniesItem) companies

CompaniesItem
Summary:
Description:

Properties:
Name Type Summary
name string Name of the company.
Company Name.

Tags
Summary:

1182 | P a g e
 Intercom

Description:

Properties:
Name Type Summary
companies array of (CompaniesItem) tags

CompaniesItem
Summary:
Description:

Properties:
Name Type Summary
name string Name of the tag.
Tag Name

1183 | P a g e
 Intercom

User_Response
Summary:
Description:

Properties:
Name Type Summary
id string Intercom defined id
Id representing the user.
created_at string yyyy-MM-
Created Date-Time ddTHH:mm:ss.fffZ
user_id string Unique identifier you
User Id have defined for the user.
email string User's email.
Email
phone string User's phone number.
Phone
name string User's name.
Name
session_count integer Number of sessions the
Session Count user has recorded.
avatar Avatar

unsubscribed_from_emails boolean An avatar image URL,

Is Unsubscribed needs to be https.
location_data Location_data

pseudonym string The pseudonym used if

Pseudonym this user was previously a
lead.

1184 | P a g e
 Intercom

Avatar
Summary:
Description:

Properties:
Name Type Summary
image_url string An avatar image URL,
Image URL needs to be https.

Location_data
Summary:
Description:

Properties:
Name Type Summary
city_name string Location of the user.
City Name
country_name string Location of the user.
Country Name
latitude number Location of the user.
Latitude
longitude number Location of the user.
Longitude
postal_code string Location of the user.
Postal Code
region_name string Location of the user.
Region Name

1185 | P a g e
 Intercom

timezone string ISO 8601 time zone for

Time Zone the user's location.

1186 | P a g e
 JIRA

JIRA
JIRA is a software development tool for agile teams to plan, track, and release
world-class software. Connecting JIRA issues to the rest of your tools helps
break down barriers and unleash the potential of your team.

Status: Preview Tier: Premium Version: 1.0.0

Actions:
Name Summary
CreateIssue (string projectKey, Create a new issue
CreateIssue body)
GetIssue (string issueKey) Get issue by Key
AddComment (string issueKey, Add comment
Comment body)
ListIssueTypes (string Get issue types
projectKey)
ListProjects () Get projects
CreateProject Create a new project
(CreateProjectParameterProject
Project)
ListStatuses (string issueType, Get statuses
string projectId)
ListProjectUsers (string List users by project
projectKey)
ListAssignableUsers (string Get assignable Users
projectKey)
ListPriorityTypes () Get priority types

1187 | P a g e
 JIRA

Triggers:
Name Summary
OnNewIssue (string When a new issue is created
projectKey)
OnNewIssueJQL (string jql) When a new issue is returned by a JQL query

Objects:
Name Summary
Comment
CommentResponse
CreateIssue
CreateIssueResponse
CreateProjectParameterProject
FullIssue
ListIssueTypesResponseItem
ListPriorityTypesResponseItem
ListProjectsResponseItem
ListProjectUsersResponseItem
ListStatusesResponseItem
OnNewIssueResponseItem

Actions:
CreateIssue
Summary: Create a new issue
Description: Create a new issue.

Syntax:
JIRA.CreateIssue (string projectKey, CreateIssue body)

1188 | P a g e
 JIRA

Parameters:
Name Type Summary Required Related
Action
projectKey string True ListProjects
(Project)
body CreateIssue True

Returns:
Type:CreateIssueResponse

GetIssue
Summary: Get issue by Key
Description: Retrieve the issue object for a given issue Key.

Syntax:
JIRA.GetIssue (string issueKey)

Parameters:
Name Type Summary Required Related
Action
issueKey string Unique Key for True
(Issue Key) the issue

Returns:
Type:FullIssue

1189 | P a g e
 JIRA

AddComment
Summary: Add comment
Description: Add a comment to an issue.

Syntax:
JIRA.AddComment (string issueKey, Comment body)

Parameters:
Name Type Summary Required Related
Action
issueKey string Unique Key of True
(Issue Key) the issue to add
a comment to
body Comment True

Returns:
Type:CommentResponse

ListIssueTypes
Summary: Get issue types
Description: Returns a list of issue types for a given project.

Syntax:
JIRA.ListIssueTypes (string projectKey)

Parameters:

1190 | P a g e
 JIRA

Name Type Summary Required Related

Action
projectKey string True ListProjects

Returns:
Type:array of (ListIssueTypesResponseItem)

ListProjects
Summary: Get projects
Description: Returns a list of projects for the JIRA instance.

Syntax:
JIRA.ListProjects ()

Returns:
Type:array of (ListProjectsResponseItem)

CreateProject
Summary: Create a new project
Description: Creates a new JIRA project.

Syntax:
JIRA.CreateProject (CreateProjectParameterProject Project)

Parameters:
Name Type Summary Required Related
Action

1191 | P a g e
 JIRA

Project CreateProjectParameterProject True

Returns:
Type:string

ListStatuses
Summary: Get statuses
Description: Returns a list of statuses for a project and issue type

Syntax:
JIRA.ListStatuses (string issueType, string projectId)

Parameters:
Name Type Summary Required Related
Action
issueType string True

projectId string True

Returns:
Type:array of (ListStatusesResponseItem)

ListProjectUsers
Summary: List users by project
Description: Retrieves a list of all users associated with a project.

Syntax:

1192 | P a g e
 JIRA

JIRA.ListProjectUsers (string projectKey)

Parameters:
Name Type Summary Required Related
Action
projectKey string True ListProjects
(Project
key)

Returns:
Type:array of (ListProjectUsersResponseItem)

ListAssignableUsers
Summary: Get assignable Users
Description: Returns a list of the users who can be assigned issues for a given project

Syntax:
JIRA.ListAssignableUsers (string projectKey)

Parameters:
Name Type Summary Required Related
Action
projectKey string True
(Project
Key)

Returns:
Type:array of (ListProjectUsersResponseItem)

1193 | P a g e
 JIRA

ListPriorityTypes
Summary: Get priority types
Description: Returns a list of priority types

Syntax:
JIRA.ListPriorityTypes ()

Returns:
Type:array of (ListPriorityTypesResponseItem)

Triggers:
Trigger OnNewIssue
Summary: When a new issue is created
Description: Triggers when a new issue is added to the given project.

Syntax:
JIRA.OnNewIssue (string projectKey)

Parameters:
Name Type Summary Required Related
Action
projectKey string Unique key of True ListProjects
(Project) the project to
look for new
issues

Returns:
Type:array of (OnNewIssueResponseItem)

1194 | P a g e
 JIRA

Trigger OnNewIssueJQL
Summary: When a new issue is returned by a JQL query
Description: Triggers when a new issue appears in the latest 100 results of a JQL query.

Syntax:
JIRA.OnNewIssueJQL (string jql)

Parameters:
Name Type Summary Required Related
Action
jql string Query to use True
(JQL Query)

Returns:
Type:array of (OnNewIssueResponseItem)

1195 | P a g e
 JIRA

Comment
Summary:
Description:

Properties:
Name Type Summary
body string
Comment Body

1196 | P a g e
 JIRA

CommentResponse
Summary:
Description:

Properties:
Name Type Summary
id string
Comment Id
body string
Comment Body
created string(date-time)
Created Date

1197 | P a g e
 JIRA

CreateIssue
Summary:
Description:

Properties:
Name Type Summary
fields Fields

Fields
Summary:
Description:

Properties:
Name Type Summary
issuetype Issuetype

summary string
Summary
reporter Reporter

description string A detailed description of

Description the issue
priority Priority

labels string Enter a comma separated

Labels list of lables
assignee Assignee

1198 | P a g e
 JIRA

parent Parent

customfield_10119 string Required epic name for

Epic Name (epic only) epic issue type

Issuetype
Summary:
Description:

Properties:
Name Type Summary
id string
Issue Type Id

Reporter
Summary:
Description:

Properties:
Name Type Summary
name string
Reporter Username

Priority
Summary:
Description:

Properties:

1199 | P a g e
 JIRA

Name Type Summary

id string
Priority Id

Assignee
Summary:
Description:

Properties:
Name Type Summary
name string
Assignee Username

Parent
Summary:
Description:

Properties:
Name Type Summary
id string Set the parent for a sub-
Parent Issue Id task

1200 | P a g e
 JIRA

CreateIssueResponse
Summary:
Description:

Properties:
Name Type Summary
id string
Issue Id
key string
Issue Key

1201 | P a g e
 JIRA

CreateProjectParameterProject
Summary:
Description:

Properties:
Name Type Summary
key string The unique key, starts
Project Key with a capital letter.
name string
Name
projectTypeKey string Values: [Software - Scrum
Type software development,
Software - Kanban
software developmnt,
Software - Basic software
development, Business -
Project management,
Business - Task
management, Business -
Process management]
lead string The username of the
Lead project lead.
description string
Project Description

1202 | P a g e
 JIRA

FullIssue
Summary:
Description:

Properties:
Name Type Summary
id string The unique Id of the Issue
Issue Id
key string The unique key of the
Issue Key issue
self string Browse to the issue using
Issue URL this URL
fields Fields

Fields
Summary:
Description:

Properties:
Name Type Summary
issuetype Issuetype

timespent string The time spent on this

Time Spent issue
project Project

aggregatetimespent string The aggregrate time

Aggregate Time Spent spent on sub-tasks

1203 | P a g e
 JIRA

resolution string
Resolution
resolutiondate string(date-time)
Resolution Date
workratio integer(int32) The percentage of
Work Ratio work logged vs the
issue estimate
created string(date-time)
Created Date
priority Priority

timeestimate integer(int32) Time rematining

Time Estimate extimated time in
seconds
aggregatetimeoriginalestimate string The original sum of all
Original Aggregate Time sub-task time
Estimate estimates in seconds
assignee Assignee

updated string(date-time)
Updated Time
status Status

timeoriginalestimate string The originaltime

Original Time Estimate estimate in seconds
description string
Description
aggregatetimeestimate integer(int32) Time sum of all sub-
Aggregate Time Estimate tasks remaining

1204 | P a g e
 JIRA

extimated time in
seconds
summary string
Summary
creator Creator

reporter Reporter

aggregateprogress Aggregateprogress

duedate string(date-time)
Due Date
progress Progress

customfield_10119 string Required epic name for

Epic Name (epic only) epic issue type

Issuetype
Summary:
Description:

Properties:
Name Type Summary
id string
Isue Type Id
description string
Issue Type Description
iconUrl string
Issue Type Icon Url

1205 | P a g e
 JIRA

name string
Issue Type Name

Project
Summary:
Description:

Properties:
Name Type Summary
id string The unique Id of the
Project Id project
key string The unique key of the
Project Key project
name string
Project Name
projectTypeKey string The unique key of the
Project Type Key project type

Priority
Summary:
Description:

Properties:
Name Type Summary
iconUrl string
Priority Icon Url
name string
Priority Name
id string

1206 | P a g e
 JIRA

Priority Id

Assignee
Summary:
Description:

Properties:
Name Type Summary
name string
Assignee Name
key string
Assignee Key
emailAddress string
Assignee Email
displayName string
Assignee Display Name

Status
Summary:
Description:

Properties:
Name Type Summary
description string
Status Description
iconUrl string
Status Icon Url
name string
Status Name

1207 | P a g e
 JIRA

id string
Status Id
statusCategory StatusCategory
Status Category

StatusCategory
Summary: Status Category
Description:

Properties:
Name Type Summary
id integer(int32)
Status Category Id
key string
Status Category Key
colorName string
Status Category Color
Name
name string
Status Category Name

Creator
Summary:
Description:

Properties:
Name Type Summary
name string
Creator Name

1208 | P a g e
 JIRA

key string
Creator Key
emailAddress string
Creator Email
displayName string
Creator Display Name

Reporter
Summary:
Description:

Properties:
Name Type Summary
name string
Reporter Name
key string
Reporter Key
emailAddress string
Reporter Email
displayName string
Reporter Display Name

Aggregateprogress
Summary:
Description:

Properties:
Name Type Summary

1209 | P a g e
 JIRA

progress integer(int32) The total progress

Aggregrate Progress completed of all sub-tasks
Completed in seconds
total integer(int32) The total sum of all
Aggregate Estimated Effort estimated sub-task effort
percent integer(int32) The percent of agregate
Aggregate Progress completed progress in
Percent relation to estimated
effort

Progress
Summary:
Description:

Properties:
Name Type Summary
progress integer(int32) The progress complete in
Progress Completed seconds
total integer(int32) The estimated effort
Estimated Effort
percent integer(int32) The percent of completed
Progress Percent progress in relation to
estimated effort

1210 | P a g e
 JIRA

ListIssueTypesResponseItem
Summary:
Description:

Properties:
Name Type Summary
name string

id string

1211 | P a g e
 JIRA

ListPriorityTypesResponseItem
Summary:
Description:

Properties:
Name Type Summary
name string

id string

1212 | P a g e
 JIRA

ListProjectsResponseItem
Summary:
Description:

Properties:
Name Type Summary
id string The unique Id of the
Project Id project
key string The unique key of the
Project Key project
name string
Project Name
projectTypeKey string The unique key of the
Project Type Key project type

1213 | P a g e
 JIRA

ListProjectUsersResponseItem
Summary:
Description:

Properties:
Name Type Summary
name string
Name
key string
Key
emailAddress string
Email
displayName string

1214 | P a g e
 JIRA

ListStatusesResponseItem
Summary:
Description:

Properties:
Name Type Summary
id string
Status Id
name string
Status Name

1215 | P a g e
 JIRA

OnNewIssueResponseItem
Summary:
Description:

Properties:
Name Type Summary
id string The unique Id of the Issue
Issue Id
key string The unique key of the
Issue Key issue
self string Browse to the issue using
Issue URL this URL
fields Fields

Fields
Summary:
Description:

Properties:
Name Type Summary
issuetype Issuetype

timespent string The time spent on this

Time Spent issue
project Project

aggregatetimespent string The aggregrate time

Aggregate Time Spent spent on sub-tasks

1216 | P a g e
 JIRA

resolution string
Resolution
resolutiondate string(date-time)
Resolution Date
workratio integer(int32) The percentage of
Work Ratio work logged vs the
issue estimate
created string(date-time)
Created Date
priority Priority

timeestimate integer(int32) Time rematining

Time Estimate extimated time in
seconds
aggregatetimeoriginalestimate string The original sum of all
Original Aggregate Time sub-task time
Estimate estimates in seconds
assignee Assignee

updated string(date-time)
Updated Time
status Status

timeoriginalestimate string The originaltime

Original Time Estimate estimate in seconds
description string
Description
aggregatetimeestimate integer(int32) Time sum of all sub-
Aggregate Time Estimate tasks remaining

1217 | P a g e
 JIRA

extimated time in
seconds
summary string
Summary
creator Creator

reporter Reporter

aggregateprogress Aggregateprogress

duedate string(date-time)
Due Date
progress Progress

customfield_10119 string Required epic name for

Epic Name (epic only) epic issue type

Issuetype
Summary:
Description:

Properties:
Name Type Summary
id string
Isue Type Id
description string
Issue Type Description
iconUrl string
Issue Type Icon Url

1218 | P a g e
 JIRA

name string
Issue Type Name

Project
Summary:
Description:

Properties:
Name Type Summary
id string The unique Id of the
Project Id project
key string The unique key of the
Project Key project
name string
Project Name
projectTypeKey string The unique key of the
Project Type Key project type

Priority
Summary:
Description:

Properties:
Name Type Summary
iconUrl string
Priority Icon Url
name string
Priority Name
id string

1219 | P a g e
 JIRA

Priority Id

Assignee
Summary:
Description:

Properties:
Name Type Summary
name string
Assignee Name
key string
Assignee Key
emailAddress string
Assignee Email
displayName string
Assignee Display Name

Status
Summary:
Description:

Properties:
Name Type Summary
description string
Status Description
iconUrl string
Status Icon Url
name string
Status Name

1220 | P a g e
 JIRA

id string
Status Id
statusCategory StatusCategory
Status Category

StatusCategory
Summary: Status Category
Description:

Properties:
Name Type Summary
id integer(int32)
Status Category Id
key string
Status Category Key
colorName string
Status Category Color
Name
name string
Status Category Name

Creator
Summary:
Description:

Properties:
Name Type Summary
name string
Creator Name

1221 | P a g e
 JIRA

key string
Creator Key
emailAddress string
Creator Email
displayName string
Creator Display Name

Reporter
Summary:
Description:

Properties:
Name Type Summary
name string
Reporter Name
key string
Reporter Key
emailAddress string
Reporter Email
displayName string
Reporter Display Name

Aggregateprogress
Summary:
Description:

Properties:
Name Type Summary

1222 | P a g e
 JIRA

progress integer(int32) The total progress

Aggregrate Progress completed of all sub-tasks
Completed in seconds
total integer(int32) The total sum of all
Aggregate Estimated Effort estimated sub-task effort
percent integer(int32) The percent of agregate
Aggregate Progress completed progress in
Percent relation to estimated
effort

Progress
Summary:
Description:

Properties:
Name Type Summary
progress integer(int32) The progress complete in
Progress Completed seconds
total integer(int32) The estimated effort
Estimated Effort
percent integer(int32) The percent of completed
Progress Percent progress in relation to
estimated effort

1223 | P a g e
 LeanKit

LeanKit
Helping teams work together to deliver customer value, faster.

Status: Preview Tier: Premium Version: 1.0.0

Actions:
Name Summary
ListBoards () List boards
CreateBoard Create a new board
(CreateBoardRequest body)
ListCards (string board) List cards
CreateCard Create a new card
(CreateCardRequest body)
GetBoard (string boardId) Get board
GetCard (string cardId) Get a card
UpdateCard (string cardId, Update a card
UpdateCardRequest body)
DeleteCard (string cardId) Delete a card
AddComment (string cardId, Add comment to a card
AddCommentRequest body)

Triggers:
Name Summary
TrigNewCard (string board, When a new card is added
string lane)
TrigUpdateCard (string board, When a card is updated
string lane)

1224 | P a g e
 LeanKit

Objects:
Name Summary
AddCommentRequest
AddCommentResponse
CardResponse
CreateBoardRequest
CreateBoardResponse
CreateCardRequest
CreateCardResponse
GetBoardResponse
ListBoardsResponse
ListCardsResponse
UpdateCardRequest

Actions:
ListBoards
Summary: List boards
Description: List boards

Syntax:
LeanKit.ListBoards ()

Returns:
Type:ListBoardsResponse

CreateBoard
Summary: Create a new board
Description: This operation is used to create a new LeanKit board.

1225 | P a g e
 LeanKit

Syntax:
LeanKit.CreateBoard (CreateBoardRequest body)

Parameters:
Name Type Summary Required Related
Action
body CreateBoardRequest True

Returns:
Type:CreateBoardResponse

ListCards
Summary: List cards
Description: List cards

Syntax:
LeanKit.ListCards (string board)

Parameters:
Name Type Summary Required Related
Action
board string Pick a board. True ListBoards
(Board Id)

Returns:
Type:ListCardsResponse

1226 | P a g e
 LeanKit

CreateCard
Summary: Create a new card
Description: This operation is used to create a new card in LeanKit.

Syntax:
LeanKit.CreateCard (CreateCardRequest body)

Parameters:
Name Type Summary Required Related
Action
body CreateCardRequest True

Returns:
Type:CreateCardResponse

GetBoard
Summary: Get board
Description: This operation is used to retrieve all information about a board in LeanKit.

Syntax:
LeanKit.GetBoard (string boardId)

Parameters:
Name Type Summary Required Related
Action
boardId string Pick a board. True ListBoards
(Board Id)

1227 | P a g e
 LeanKit

Returns:
Type:GetBoardResponse

GetCard
Summary: Get a card
Description: This operation is used to retrieve all information about a card, given its id.

Syntax:
LeanKit.GetCard (string cardId)

Parameters:
Name Type Summary Required Related
Action
cardId string True
(Card Id)

Returns:
Type:CardResponse

UpdateCard
Summary: Update a card
Description: This operation is used to update the details of an existing card given its id.

Syntax:
LeanKit.UpdateCard (string cardId, UpdateCardRequest body)

Parameters:

1228 | P a g e
 LeanKit

Name Type Summary Required Related

Action
cardId string True
(Card Id)
body UpdateCardRequest True

Returns:
Type:CardResponse

DeleteCard
Summary: Delete a card
Description: This operation is used to delete an existing card in LeaKit.

Syntax:
LeanKit.DeleteCard (string cardId)

Parameters:
Name Type Summary Required Related
Action
cardId string True
(Card Id)

Returns:
Type:CardResponse

AddComment
Summary: Add comment to a card
Description: This operation is used to add a comment to an existing card in LeanKit.

1229 | P a g e
 LeanKit

Syntax:
LeanKit.AddComment (string cardId, AddCommentRequest body)

Parameters:
Name Type Summary Required Related
Action
cardId string True
(Card Id)
body AddCommentRequest True

Returns:
Type:AddCommentResponse

Triggers:
Trigger TrigNewCard
Summary: When a new card is added
Description: Triggers when a new card is added to the given board and lane.

Syntax:
LeanKit.TrigNewCard (string board, string lane)

Parameters:
Name Type Summary Required Related
Action
board string Pick a board. True ListBoards
(Board Id)

1230 | P a g e
 LeanKit

lane string Pick a lane. True GetBoard

(Lane Id)

Returns:
Type:array of (CardResponse)

Trigger TrigUpdateCard
Summary: When a card is updated
Description: Triggers when the details of an existing card are updated.

Syntax:
LeanKit.TrigUpdateCard (string board, string lane)

Parameters:
Name Type Summary Required Related
Action
board string Pick a board. True ListBoards
(Board Id)
lane string Pick a lane. True GetBoard
(Lane Id)

Returns:
Type:array of (CardResponse)

1231 | P a g e
 LeanKit

AddCommentRequest
Summary:
Description:

Properties:
Name Type Summary
text string
Comment

1232 | P a g e
 LeanKit

AddCommentResponse
Summary:
Description:

Properties:
Name Type Summary
id string Comment id.
Id
createdOn string(date-time) yyyy-MM-
Created Date-Time ddTHH:mm:ss.fffZ
createdBy CreatedBy Details of comment author.
Author
text string Body of the comment.
Comment

CreatedBy
Summary: Author
Description: Details of comment author.

Properties:
Name Type Summary
id string Comment author's user id.
Id
emailAddress string Email address of the
Email comment author.
fullName string Full name of the comment
Name author.

1233 | P a g e
 LeanKit

CardResponse
Summary:
Description:

Properties:
Name Type Summary
actualFinish string(date-time) yyyy-MM-
Finish Date-Time ddTHH:mm:ss.fffZ
actualStart string(date-time) yyyy-MM-
Start Date-Time ddTHH:mm:ss.fffZ
blockedStatus BlockedStatus Blocked status details.
Blocked
board Board Board details.
Board
createdOn string(date-time) yyyy-MM-
Created Date-Time ddTHH:mm:ss.fffZ
archivedOn string(date-time) yyyy-MM-
Archived Date-Time ddTHH:mm:ss.fffZ
description string Card's description.
Description
plannedFinish string yyyy-MM-dd
Planned Finish Date
customId CustomId Card's custom id.
Custom Id
id string Id of the Card.
Card Id
lane Lane Details of the lane.
Lane

1234 | P a g e
 LeanKit

updatedOn string(date-time) yyyy-MM-

Updated Date-Time ddTHH:mm:ss.fffZ
movedOn string(date-time) yyyy-MM-
Moved Date-Time ddTHH:mm:ss.fffZ
priority string Priority of task on card.
Priority
size integer(int32) Card size.
Size
plannedStart string yyyy-MM-dd
Planned Start Date
title string Card title.
Title
version string Card version.
Version
type Type Details about the type of
Type card.

BlockedStatus
Summary: Blocked
Description: Blocked status details.

Properties:
Name Type Summary
isBlocked boolean True if the card is blocked.
Is Blocked
reason string Reason the card is blocked.
Reason
date string(date-time) yyyy-MM-
Blocked Date-Time ddTHH:mm:ss.fffZ

1235 | P a g e
 LeanKit

Board
Summary: Board
Description: Board details.

Properties:
Name Type Summary
id string Board id.
Id
title string Board title.
Title
version integer(int32) Board version.
Version

CustomId
Summary: Custom Id
Description: Card's custom id.

Properties:
Name Type Summary
value string Card's custom id value.
Value

Lane
Summary: Lane
Description: Details of the lane.

Properties:

1236 | P a g e
 LeanKit

Name Type Summary

description string Lane description.
Description
id string Lane id.
Id
laneClassType string Lane's class type.
Class Type
laneType string Lane type.
Type
title string Lane title.
Title

Type
Summary: Type
Description: Details about the type of card.

Properties:
Name Type Summary
title string Card type.
Type

1237 | P a g e
 LeanKit

CreateBoardRequest
Summary:
Description:

Properties:
Name Type Summary
title string
Title
description string
Description

1238 | P a g e
 LeanKit

CreateBoardResponse
Summary:
Description:

Properties:
Name Type Summary
id string Unique identifier of the
Board Id board.

1239 | P a g e
 LeanKit

CreateCardRequest
Summary:
Description:

Properties:
Name Type Summary
boardId string Pick a board.
Board Id
typeId string Pick a card type.
Type
title string
Title
description string
Description
laneId string Pick a card lane.
Lane Id
priority string Pick a card priority.
Priority
size integer(int32)
Size
tags string Comma seperated list of
Tags tags.
plannedStart string YYYY-MM-DD
Planned Start Date
plannedFinish string YYYY-MM-DD
Planned Finish Date
customId string
Card Id

1240 | P a g e
 LeanKit

isBlocked boolean True if the card is

Is Blocked blocked.
blockReason string
Block Reason
externalLink ExternalLink

assignedUserIds array of (string) Array of user Ids

Assignees (numbers).

ExternalLink
Summary:
Description:

Properties:
Name Type Summary
label string
External Link Label
url string
External Link URL

1241 | P a g e
 LeanKit

CreateCardResponse
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Unique identifier of the
Card Id card.

1242 | P a g e
 LeanKit

GetBoardResponse
Summary:
Description:

Properties:
Name Type Summary
cardTypes array of (CardTypesItem) Type of card.
Card Type
lanes array of (LanesItem) Board lanes.
Lanes
priorities array of (PrioritiesItem) Board priorities.
Priorities

CardTypesItem
Summary:
Description:

Properties:
Name Type Summary
name string Card type.
Type

LanesItem
Summary:
Description:

Properties:
Name Type Summary
id string Lane id.

1243 | P a g e
 LeanKit

Id
name string Lane name.
Name

PrioritiesItem
Summary:
Description:

Properties:
Name Type Summary
name string Priority name.
Name

1244 | P a g e
 LeanKit

ListBoardsResponse
Summary:
Description:

Properties:
Name Type Summary
boards array of (BoardsItem) Boards array.
Boards

BoardsItem
Summary:
Description:

Properties:
Name Type Summary
id string Board id.
Id
title string Board title.
Title

1245 | P a g e
 LeanKit

ListCardsResponse
Summary:
Description:

Properties:
Name Type Summary
cards array of (CardResponse) cards
cards

1246 | P a g e
 LeanKit

UpdateCardRequest
Summary:
Description:

Properties:
Name Type Summary
typeId string Pick the card type.
Type
title string
Title
description string
Description
laneId string Pick a card lane.
Lane Id
priority string Pick a card priority.
Priority
size integer(int32)
Size
tags string Comma-seperated list of
Tags tags.
plannedStart string YYYY-MM-DD
Planned Start Date-Time
plannedFinish string YYYY-MM-DD
Planned Finish Date-Time
customId string
Card Id
isBlocked boolean True if the card is
Is Blocked blocked.
blockReason string

1247 | P a g e
 LeanKit

Block Reason
externalLink ExternalLink

assignedUserIds array of (string) Array of user Ids

Assignees (numbers).

ExternalLink
Summary:
Description:

Properties:
Name Type Summary
label string The label of the external
External Link Label link.
url string The URL of the external
External Link URL link.

1248 | P a g e
 LiveChat

LiveChat
LiveChat is an online customer service software with live support, help desk
software and web analytics capabilities.

Status: Preview Tier: Premium Version: 1.0.0

Actions:
Name Summary
DeleteHook (string hookId) Delete hook
ListAgents () List agents
CreateAgent Create a new agent
(CreateAgent_Request body)
DeleteAgent (string login) Remove an agent
ListTickets () List tickets
CreateTicket Create a new ticket
(Createticket_Request body)
UpdateTicket (string ticketId, Update ticket
Updateticket_Request body)
GetTicket (string ticketId) Get ticket
WebhookResponse
([Optional]string
logicAppsUri)

Triggers:
Name Summary
WebhookTicketCreated When a ticket is created
([internal]string event_type,
[internal]string data_types[],

1249 | P a g e
 LiveChat

[Optional]WebhookRequest
body)
WebhookChatStarted When a chat starts
([internal]string event_type,
[Optional]WebhookRequest
body)
WebhookChatEnded When a chat ends
([internal]string event_type,
[Optional]WebhookRequest
body)

Objects:
Name Summary
CreateAgent_Request
CreateAgent_Response
Createticket_Request
DeleteAgent_Response
ListAgentsResponseItem
ListTicketsResponseItem
TicketResponse
Updateticket_Request
WebhookRequest

Actions:
DeleteHook
Summary: Delete hook
Description: Delete a hook.

1250 | P a g e
 LiveChat

Syntax:
LiveChat.DeleteHook (string hookId)

Parameters:
Name Type Summary Required Related
Action
hookId string True

Returns:

ListAgents
Summary: List agents
Description: This operation returns a list of all the agents in your LiveChat account.

Syntax:
LiveChat.ListAgents ()

Returns:
Type:array of (ListAgentsResponseItem)
Summary: Agents Array
Description: List of all agents with their details.

CreateAgent
Summary: Create a new agent
Description: This operation is used to add a new agent to your LiveChat account.

Syntax:
LiveChat.CreateAgent (CreateAgent_Request body)

1251 | P a g e
 LiveChat

Parameters:
Name Type Summary Required Related
Action
body CreateAgent_Request True

Returns:
Type:CreateAgent_Response

DeleteAgent
Summary: Remove an agent
Description: This operation is used to delete an agent from your LiveChat account.

Syntax:
LiveChat.DeleteAgent (string login)

Parameters:
Name Type Summary Required Related
Action
login string True
(Email)

Returns:
Type:DeleteAgent_Response

ListTickets
Summary: List tickets
Description: This operation returns a list of tickets in your LiveChat account.

1252 | P a g e
 LiveChat

Syntax:
LiveChat.ListTickets ()

Returns:
Type:array of (ListTicketsResponseItem)

CreateTicket
Summary: Create a new ticket
Description: This operation is used to add a new ticket to your LiveChat account.

Syntax:
LiveChat.CreateTicket (Createticket_Request body)

Parameters:
Name Type Summary Required Related
Action
body Createticket_Request True

Returns:
Type:TicketResponse

UpdateTicket
Summary: Update ticket
Description: This operation is used to update the details of an existing ticket in your
LiveChat account.

Syntax:

1253 | P a g e
 LiveChat

LiveChat.UpdateTicket (string ticketId, Updateticket_Request

body)

Parameters:
Name Type Summary Required Related
Action
ticketId string True
(Ticket Id)
body Updateticket_Request True

Returns:
Type:TicketResponse

GetTicket
Summary: Get ticket
Description: This operation is used to fetch the details of a specific ticket in your
LiveChat account.

Syntax:
LiveChat.GetTicket (string ticketId)

Parameters:
Name Type Summary Required Related
Action
ticketId string True
(Ticket Id)

Returns:

1254 | P a g e
 LiveChat

Type:TicketResponse

WebhookResponse
Summary:
Description:

Syntax:
LiveChat.WebhookResponse ([Optional]string logicAppsUri)

Parameters:
Name Type Summary Required Related
Action
logicAppsUri string False

Returns:

Triggers:
Trigger WebhookTicketCreated
Summary: When a ticket is created
Description: This operation triggers when a new ticket is added.

Syntax:
LiveChat.WebhookTicketCreated ([internal]string event_type,
[internal]string data_types[], [Optional]WebhookRequest body)

Parameters:

1255 | P a g e
 LiveChat

Name Type Summary Required Related

Action
event_type string True

data_types[] string True

body WebhookRequest False

Returns:
Type:string

Trigger WebhookChatStarted
Summary: When a chat starts
Description: This operation triggers when new a chat starts.

Syntax:
LiveChat.WebhookChatStarted ([internal]string event_type,
[Optional]WebhookRequest body)

Parameters:
Name Type Summary Required Related
Action
event_type string True

body WebhookRequest False

Returns:

1256 | P a g e
 LiveChat

Type:string

Trigger WebhookChatEnded
Summary: When a chat ends
Description: This operation triggers when a chat ends.

Syntax:
LiveChat.WebhookChatEnded ([internal]string event_type,
[Optional]WebhookRequest body)

Parameters:
Name Type Summary Required Related
Action
event_type string True

body WebhookRequest False

Returns:
Type:string

1257 | P a g e
 LiveChat

CreateAgent_Request
Summary:
Description:

Properties:
Name Type Summary
login string
Email
name string
Name
login_status string Values: [accepting chats,
Login status not accepting chats]
job_title string Defaults to: Support
Title Agent.
permission string Values: [administrator,
Permission normal]
password string Minimum length 5.
Password
max_chats_count string Limit of the concurrent
Max chat counts chats.

1258 | P a g e
 LiveChat

CreateAgent_Response
Summary:
Description:

Properties:
Name Type Summary
avatar string Path to the image on
Avatar Amazon s3.
groups array of (GroupsItem) List of all groups the agent
Groups Array is a part of.
job_title string Support agent by default.
Job Title
license_id integer(int32) license_id
License Id
login string The agent's email address.
Email
login_status string Accepting chats or not
Login Status accepting chats.
max_chats_count integer(int32) Limit of the concurrent
Max Chat Counts chats.
name string Agent's name.
Name
permission string Owner, administrator or
Permission normal
status string Accepting chats, not
Status accepting chats or offline.

GroupsItem
Summary:

1259 | P a g e
 LiveChat

Description:

Properties:
Name Type Summary
id integer(int32) Unique id of the group.
Group Id
name string Name of the group.
Group Name

1260 | P a g e
 LiveChat

Createticket_Request
Summary:
Description:

Properties:
Name Type Summary
message string
Message
requester Requester

subject string
Subject
assignee Assignee

source Source

Requester
Summary:
Description:

Properties:
Name Type Summary
mail string
Requester's Email
name string
Requester's Name

1261 | P a g e
 LiveChat

Assignee
Summary:
Description:

Properties:
Name Type Summary
id string
Assignee Id

Source
Summary:
Description:

Properties:
Name Type Summary
type string Pick a source Values:
Source Type [chat-window, mail, lc2]
url string If source type is chat-
Source URL window.

1262 | P a g e
 LiveChat

DeleteAgent_Response
Summary:
Description:

Properties:
Name Type Summary
result string
Result

1263 | P a g e
 LiveChat

ListAgentsResponseItem
Summary:
Description:

Properties:
Name Type Summary
avatar string Path to the image on
Avatar Amazon s3.
login string The agent's email address.
Login Email
name string Agent's name.
Name
permission string Owner, administrator or
Permission normal.

1264 | P a g e
 LiveChat

ListTicketsResponseItem
Summary:
Description:

Properties:
Name Type Summary
date string(date-time) yyyy-MM-
Created Date-Time ddTHH:mm:ss.fffZ
id string Unique identifier of the
Ticket Id ticket.
modified string(date-time) yyyy-MM-
Modified Date-Time ddTHH:mm:ss.fffZ
requester Requester requester
Requester
source Source Details of the ticket source.
Source
status string Open, pending, solved or
Status spam.
subject string Description of the ticket
Subject source.

Requester
Summary: Requester
Description: requester

Properties:
Name Type Summary
ip string IP address of the
IP requester.

1265 | P a g e
 LiveChat

mail string Email address of the

Email requester.
name string Full name of the
Name requester.

Source
Summary: Source
Description: Details of the ticket source.

Properties:
Name Type Summary
id string Unique identifier of the
Id source.
type string From chat, mail or lc2.
Type
url string Webpage where the ticket
URL was created.

1266 | P a g e
 LiveChat

TicketResponse
Summary:
Description:

Properties:
Name Type Summary
currentGroup CurrentGroup currentGroup
Group
date string(date-time) yyyy-MM-
Created Date-Time ddTHH:mm:ss.fffZ
events array of (EventsItem)

groups array of (GroupsItem) Details of the associated

Group group.
id string Unique id of the ticket.
Ticket Id
requester Requester Details of the requester.
Requester
source Source
Source
status string Open, pending, solved or
Status spam.
subject string Short description of the
Subject ticket.
tags array of (string)

CurrentGroup
Summary: Group

1267 | P a g e
 LiveChat

Description: currentGroup

Properties:
Name Type Summary
id integer(int32) Unique id of the group.
Id
name string Name of the group.
Name

EventsItem
Summary:
Description:

Properties:
Name Type Summary
author Author
Author
date string(date-time) yyyy-MM-
Event Date-Time ddTHH:mm:ss.fffZ
is_private boolean True if event is private.
Is Private
message string Description of the event.
Message
source Source Ticket source description.
Source
type string Type of event that
Event Type generated the ticket.

1268 | P a g e
 LiveChat

Author
Summary: Author
Description:

Properties:
Name Type Summary
id string Unique id of the user.
Id
name string Name of the author.
Name
type string Agent or client.
Type

Source
Summary: Source
Description: Ticket source description.

Properties:
Name Type Summary
type string Chat-window, mail or lc2.
Type
url string Url of the website that the
URL ticket was sent from.

GroupsItem
Summary:
Description:

Properties:

1269 | P a g e
 LiveChat

Name Type Summary

id integer(int32) Unique id of the group.
Id
name string Name of the group.
Name

Requester
Summary: Requester
Description: Details of the requester.

Properties:
Name Type Summary
ip string IP address of the
IP requester.
mail string Email address of the
Email requester.
name string Name of the requester.
Name

Source
Summary: Source
Description:

Properties:
Name Type Summary
id string Unique id of the source.
Id

1270 | P a g e
 LiveChat

type string Lc2, mail, facebook, agent-

Type app-manual or chat-
window.
url string Url of the website where
URL ticket was created.

1271 | P a g e
 LiveChat

Updateticket_Request
Summary:
Description:

Properties:
Name Type Summary
message string
Message
requester Requester

subject string
Subject
assignee Assignee

source Source

Requester
Summary:
Description:

Properties:
Name Type Summary
mail string
Requester's Email
name string
Requester's Name

1272 | P a g e
 LiveChat

Assignee
Summary:
Description:

Properties:
Name Type Summary
id string Pick an assignee.
Assignee Id

Source
Summary:
Description:

Properties:
Name Type Summary
type string Pick a source. Values:
Source Type [chat-window, mail, lc2]
url string If source type is chat-
Source URL window.

1273 | P a g e
 LiveChat

WebhookRequest
Summary:
Description:

Properties:
Name Type Summary
url string url
url

1274 | P a g e
 Logic flows

Logic flows

Status: Tier: Standard Version: 2015-08-01-

preview

Actions:
Name Summary
Workflow_Get (string api-
version)
WorkflowTriggers_List (string
api-version, [Optional]integer
$top)
WorkflowTriggers_Get (string
triggerName, string api-
version)
WorkflowTriggers_Run (string
triggerName, string api-
version)
WorkflowTriggerHistories_List
(string triggerName, string
api-version, [Optional]integer
$top)
WorkflowTriggerHistories_Get
(string triggerName, string
historyName, string api-
version)

1275 | P a g e
 Logic flows

WorkflowRuns_List (string
api-version, [Optional]integer
$top, [Optional]string $filter)
WorkflowRuns_Get (string
runName, string api-version)
WorkflowRunActions_List
(string runName, string api-
version, [Optional]integer
$top, [Optional]string $filter)
WorkflowRunActions_Get
(string runName, string
actionName, string api-
version)

Triggers:
Name Summary

Objects:
Name Summary
ContentHash
ContentLink
Object
ResourceReference
Workflow
WorkflowProperties
WorkflowRun
WorkflowRunAction
WorkflowRunActionListResult

1276 | P a g e
 Logic flows

WorkflowRunActionProperties
WorkflowRunListResult
WorkflowRunProperties
WorkflowTrigger
WorkflowTriggerHistory
WorkflowTriggerHistoryListResult
WorkflowTriggerHistoryProperties
WorkflowTriggerListResult
WorkflowTriggerProperties
WorkflowTriggerRecurrence

Actions:
Workflow_Get
Summary:
Description: Gets a workflow.

Syntax:
Logicflows.Workflow_Get (string api-version)

Parameters:
Name Type Summary Required Related
Action
api-version string The logic flow True
API version.

Returns:
Type:Workflow

1277 | P a g e
 Logic flows

WorkflowTriggers_List
Summary:
Description: Gets a list of logic flow triggers.

Syntax:
Logicflows.WorkflowTriggers_List (string api-version,
[Optional]integer $top)

Parameters:
Name Type Summary Required Related
Action
api-version string The logic flow True
API version.
$top integer(int32) The number of False
items to be
included in the
result.

Returns:
Type:WorkflowTriggerListResult

WorkflowTriggers_Get
Summary:
Description: Gets a logic flow trigger.

Syntax:
Logicflows.WorkflowTriggers_Get (string triggerName, string api-
version)

1278 | P a g e
 Logic flows

Parameters:
Name Type Summary Required Related
Action
triggerName string The logic flow True
trigger name.
api-version string The logic flow True
API version.

Returns:
Type:WorkflowTrigger

WorkflowTriggers_Run
Summary:
Description: Runs a logic flow trigger.

Syntax:
Logicflows.WorkflowTriggers_Run (string triggerName, string api-
version)

Parameters:
Name Type Summary Required Related
Action
triggerName string The logic flow True
trigger name.
api-version string The logic flow True
API version.

Returns:

1279 | P a g e
 Logic flows

WorkflowTriggerHistories_List
Summary:
Description: Gets a list of logic flow trigger histories.

Syntax:
Logicflows.WorkflowTriggerHistories_List (string triggerName,
string api-version, [Optional]integer $top)

Parameters:
Name Type Summary Required Related
Action
triggerName string The logic flow True
trigger name.
api-version string The logic flow True
API version.
$top integer(int32) The number of False
items to be
included in the
result.

Returns:
Type:WorkflowTriggerHistoryListResult

WorkflowTriggerHistories_Get
Summary:
Description: Gets a logic flow trigger history.

Syntax:

1280 | P a g e
 Logic flows

Logicflows.WorkflowTriggerHistories_Get (string triggerName,

string historyName, string api-version)

Parameters:
Name Type Summary Required Related
Action
triggerName string The logic flow True
trigger name.
historyName string The logic flow True
trigger history
name.
api-version string The logic flow True
API version.

Returns:
Type:WorkflowTriggerHistory

WorkflowRuns_List
Summary:
Description: Gets a list of logic flow runs.

Syntax:
Logicflows.WorkflowRuns_List (string api-version,
[Optional]integer $top, [Optional]string $filter)

Parameters:
Name Type Summary Required Related
Action

1281 | P a g e
 Logic flows

api-version string The logic flow True

API version.
$top integer(int32) The number of False
items to be
included in the
result.
$filter string The filter to False
apply on the
operation.

Returns:
Type:WorkflowRunListResult

WorkflowRuns_Get
Summary:
Description: Gets a logic flow run.

Syntax:
Logicflows.WorkflowRuns_Get (string runName, string api-version)

Parameters:
Name Type Summary Required Related
Action
runName string The logic flow True
run name.
api-version string The logic flow True
API version.

Returns:

1282 | P a g e
 Logic flows

Type:WorkflowRun

WorkflowRunActions_List
Summary:
Description: Gets a list of logic flow run actions.

Syntax:
Logicflows.WorkflowRunActions_List (string runName, string api-
version, [Optional]integer $top, [Optional]string $filter)

Parameters:
Name Type Summary Required Related
Action
runName string The logic flow True
run name.
api-version string The logic flow True
API version.
$top integer(int32) The number of False
items to be
included in the
result.
$filter string The filter to False
apply on the
operation.

Returns:
Type:WorkflowRunActionListResult

1283 | P a g e
 Logic flows

WorkflowRunActions_Get
Summary:
Description: Gets a logic flow run action.

Syntax:
Logicflows.WorkflowRunActions_Get (string runName, string
actionName, string api-version)

Parameters:
Name Type Summary Required Related
Action
runName string The logic flow True
run name.
actionName string The logic flow True
run action name.
api-version string The logic flow True
API version.

Returns:
Type:WorkflowRunAction

1284 | P a g e
 Logic flows

ContentHash
Summary:
Description:

Properties:
Name Type Summary
algorithm string Gets or sets the algorithm.

value string Gets or sets the value.

1285 | P a g e
 Logic flows

ContentLink
Summary:
Description:

Properties:
Name Type Summary
uri string Gets or sets the content
link URI.
contentVersion string Gets or sets the content
version.
contentSize integer(int64) Gets or sets the content
size.
contentHash ContentHash

metadata Object

1286 | P a g e
 Logic flows

Object
Summary:
Description:

Properties:
Name Type Summary

1287 | P a g e
 Logic flows

ResourceReference
Summary:
Description:

Properties:
Name Type Summary
id string Gets or sets the resource
id.

1288 | P a g e
 Logic flows

Workflow
Summary:
Description:

Properties:
Name Type Summary
properties WorkflowProperties

1289 | P a g e
 Logic flows

WorkflowProperties
Summary:
Description:

Properties:
Name Type Summary
state string Values: [NotSpecified,
Enabled, Disabled,
Deleted, Suspended]
definition Object

parameters Parameters Gets or sets the

parameters.

Parameters
Summary:
Description: Gets or sets the parameters.

Properties:
Name Type Summary

1290 | P a g e
 Logic flows

WorkflowRun
Summary:
Description:

Properties:
Name Type Summary
properties WorkflowRunProperties

1291 | P a g e
 Logic flows

WorkflowRunAction
Summary:
Description:

Properties:
Name Type Summary
properties WorkflowRunActionProperties

1292 | P a g e
 Logic flows

WorkflowRunActionListResult
Summary:
Description:

Properties:
Name Type Summary
value array of Gets or sets a list of logic
(WorkflowRunAction) flow run actions.

nextLink string Gets or sets the URL to

get the next set of results.

1293 | P a g e
 Logic flows

WorkflowRunActionProperties
Summary:
Description:

Properties:
Name Type Summary
startTime string(date-time) Gets the start time.

endTime string(date-time) Gets the end time.

status string Values: [NotSpecified,

Paused, Running, Waiting,
Succeeded, Skipped,
Suspended, Cancelled,
Failed]
code string Gets the code.

error Object

trackingId string Gets the trackingId.

inputsLink ContentLink

outputsLink ContentLink

1294 | P a g e
 Logic flows

WorkflowRunListResult
Summary:
Description:

Properties:
Name Type Summary
value array of (WorkflowRun) Gets or sets a list of logic
flow runs.
nextLink string Gets or sets the URL to
get the next set of results.

1295 | P a g e
 Logic flows

WorkflowRunProperties
Summary:
Description:

Properties:
Name Type Summary
startTime string(date-time) Gets the start time.

endTime string(date-time) Gets the end time.

status string Values: [NotSpecified,

Paused, Running, Waiting,
Succeeded, Skipped,
Suspended, Cancelled,
Failed]
code string Gets the code.

error Object

correlationId string Gets the trackingId.

1296 | P a g e
 Logic flows

WorkflowTrigger
Summary:
Description:

Properties:
Name Type Summary
properties WorkflowTriggerProperties

1297 | P a g e
 Logic flows

WorkflowTriggerHistory
Summary:
Description:

Properties:
Name Type Summary
properties WorkflowTriggerHistoryProperties

1298 | P a g e
 Logic flows

WorkflowTriggerHistoryListResult
Summary:
Description:

Properties:
Name Type Summary
value array of Gets or sets a list of logic
(WorkflowTriggerHistory) flow trigger histories.

nextLink string Gets or sets the URL to

get the next set of
results.

1299 | P a g e
 Logic flows

WorkflowTriggerHistoryProperties
Summary:
Description:

Properties:
Name Type Summary
startTime string(date-time) Gets the start time.

endTime string(date-time) Gets the end time.

status string Values: [NotSpecified,

Paused, Running, Waiting,
Succeeded, Skipped,
Suspended, Cancelled,
Failed]
code string Gets the code.

error Object

trackingId string Gets the tracking id.

inputsLink ContentLink

outputsLink ContentLink

fired boolean Gets a value indicating

whether trigger was fired.
run ResourceReference

1300 | P a g e
 Logic flows

1301 | P a g e
 Logic flows

WorkflowTriggerListResult
Summary:
Description:

Properties:
Name Type Summary
value array of (WorkflowTrigger) Gets or sets a list of logic
flow triggers.
nextLink string Gets or sets the URL to
get the next set of results.

1302 | P a g e
 Logic flows

WorkflowTriggerProperties
Summary:
Description:

Properties:
Name Type Summary
createdTime string(date-time) Gets the created time.

changedTime string(date-time) Gets the changed time.

state string Values: [NotSpecified,

Enabled, Disabled,
Deleted, Suspended]
status string Values: [NotSpecified,
Paused, Running,
Waiting, Succeeded,
Skipped, Suspended,
Cancelled, Failed]
lastExecutionTime string(date-time) Gets the last execution
time.
nextExecutionTime string(date-time) Gets the next execution
time.
recurrence WorkflowTriggerRecurrence

workflow ResourceReference

1303 | P a g e
 Logic flows

WorkflowTriggerRecurrence
Summary:
Description:

Properties:
Name Type Summary
frequency string Values: [Second, Minute,
Hour, Day, Week, Month,
Year]
interval integer(int32) Gets or sets the interval.

startTime string(date-time) Gets or sets the start

time.
timeZone string Gets or sets the time
zone.

1304 | P a g e
 LUIS

LUIS
Azure cognitive services language understanding intelligent service (LUIS) lets
you understand language contextually, so your apps communicate with
people in the way they speak.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
GetPredictions (string app-id, Get prediction
string q, [Optional]string
desiredIntent,
[internal]boolean verbose)
ListApps () List Apps
ListIntents (string app-id) List Intents
ListEntities (string app-id) List Entities
GetTopScoringMatchingEntity Get entity by type
(string app-id, string
desiredEntity, string
luisPredictionObject)

Triggers:
Name Summary

Objects:
Name Summary
App
Entity

1305 | P a g e
 LUIS

EntityMatchInfo
GetTopScoringMatchingEntityResponse
Intent
LuisPredictResponseEntity
LuisPredictResponseEntityMinusType
PredictResponse

Actions:
GetPredictions
Summary: Get prediction
Description: Given some input text, this operations returns a prediction based on a
pre-trained model. The prediction object returned can also be used as input for other
LUIS actions.

Syntax:
LUIS.GetPredictions (string app-id, string q, [Optional]string
desiredIntent, [internal]boolean verbose)

Parameters:
Name Type Summary Required Related
Action
app-id string Id of the trained True ListApps
(App Id) application.
q string String to predict True
(Utterance
Text)
desiredIntent string Desired top False ListIntents
(Desired scoring intent
Intent)

1306 | P a g e
 LUIS

verbose boolean True

Returns:
Type:PredictResponse

ListApps
Summary: List Apps
Description: List Apps In Your Subscription

Syntax:
LUIS.ListApps ()

Returns:
Type:array of (App)

ListIntents
Summary: List Intents
Description: List Intents For Selected App

Syntax:
LUIS.ListIntents (string app-id)

Parameters:
Name Type Summary Required Related
Action
app-id string Id of the trained True ListApps
(App Id) application.

1307 | P a g e
 LUIS

Returns:
Type:array of (Intent)

ListEntities
Summary: List Entities
Description: List Entities For Selected App

Syntax:
LUIS.ListEntities (string app-id)

Parameters:
Name Type Summary Required Related
Action
app-id string Id of the trained True ListApps
(App Id) application.

Returns:
Type:array of (Entity)

GetTopScoringMatchingEntity
Summary: Get entity by type
Description: For a given entity type, the operation returns the best matching entity
model from the LUIS prediction object.

Syntax:
LUIS.GetTopScoringMatchingEntity (string app-id, string
desiredEntity, string luisPredictionObject)

Parameters:

1308 | P a g e
 LUIS

Name Type Summary Required Related

Action
app-id string Id of the trained True ListApps
(App Id) application
desiredEntity string The Desired True ListEntities
(Desired Entity.
Entity)
luisPredictionObject string Output from True
(LUIS 'Get Predictions'
Prediction) action

Returns:
Type:GetTopScoringMatchingEntityResponse

1309 | P a g e
 LUIS

App
Summary:
Description:

Properties:
Name Type Summary
ID string LUIS app id.
App ID
Name string Name of the LUIS app.
App name

1310 | P a g e
 LUIS

Entity
Summary:
Description:

Properties:
Name Type Summary
id string Id of the LUIS entity
Entity Id model.
name string Name of the entity model.
Entity Name

1311 | P a g e
 LUIS

EntityMatchInfo
Summary:
Description:

Properties:
Name Type Summary
desiredEntity string Desired entity specified as
Desired Entity input, if any.
isEntityMatch boolean True if the specific entity
Is Entity Match was found.
entityMatchCount integer Number of entities that
Entity Match Count match the desired entity
type.

1312 | P a g e
 LUIS

GetTopScoringMatchingEntityResponse
Summary:
Description:

Properties:
Name Type Summary
entity LuisPredictResponseEntityMinusType

entityMatchInfo EntityMatchInfo

1313 | P a g e
 LUIS

Intent
Summary:
Description:

Properties:
Name Type Summary
id string Id of the LUIS intent
Intent Id model.
name string Name of the intent model.
Intent Name
type string Type of the intent model.
Intent Type

1314 | P a g e
 LUIS

LuisPredictResponseEntity
Summary:
Description:

Properties:
Name Type Summary
entity string Value of the
Entity Value corresponding entity type.
type string Name of the entity model.
Entity Type
startIndex integer(int32) Start Index
Start Index
endIndex integer(int32) End Index
End Index
score number(float) Percent confidence of
Entity Score prediction.

1315 | P a g e
 LUIS

LuisPredictResponseEntityMinusType
Summary:
Description:

Properties:
Name Type Summary
entity string Value of the
Entity Value corresponding entity type.
score number(float) Percent confidence of
Entity Score prediction.
resolution string The resolution of this
Entity Resolution entity. Only applies to built
in entities.

1316 | P a g e
 LUIS

PredictResponse
Summary:
Description:

Properties:
Name Type Summary
luisPrediciton string Used as input for other
LUIS Prediction other LUIS actions.
isDesiredIntent boolean True if the top scoring
Is Desired Intent intent matches the
desired intent.
desiredIntent string Desired intent specified
Desired Intent as input, if any.
query string String that the
Utterance Text prediction is based off.
topScoringIntent TopScoringIntent Top scoring intent
Top Scoring Intent model.
intents array of (IntentsItem) List of all predicted
Intents Array intents.
entities array of List of all predicted
(LuisPredictResponseEntity) entities.
Entities Array

TopScoringIntent
Summary: Top Scoring Intent
Description: Top scoring intent model.

Properties:
Name Type Summary

1317 | P a g e
 LUIS

intent string Name of the intent model.

Name
score number(float) Percent confidence of
Score prediction.

IntentsItem
Summary:
Description:

Properties:
Name Type Summary
intent string Name of the intent model.
Intent Name
score number(float) Percent confidence of
Intent Score prediction.

1318 | P a g e
 MailChimp

MailChimp
MailChimp is a SaaS service that allows businesses to manage and automate
email marketing activities, including sending marketing emails, automated
messages and targeted campaigns.

Status: Production Tier: Premium Version: 1.0

Actions:
Name Summary
newcampaign New Campaign
(NewCampaignRequest
newCampaignRequest)
GetLists () Get all the lists
newlist (NewListRequest New List
newListRequest)
GetListMembers (string Show list members
list_id)
addmember (string list_id, Add member to list
NewMemberInListRequest
newMemberInList)
removemember (string list_id, Remove Member from list (V1)
string member_email)
updatemember (string list_id, Update member information. (V1)
string member_email,
UpdateMemberInListRequest
updateMemberInListRequest)
removemember_v2 (string Remove Member from list (V2)
list_id, string member_email)

1319 | P a g e
 MailChimp

updatemember_v2 (string Update member information (V2)

list_id, string member_email,
UpdateMemberInListRequest
updateMemberInListRequest)

Triggers:
Name Summary
OnMemberSubscribed (string When a Member has been added to a list
list_id)
OnCreateList () When a new list is created

Objects:
Name Summary
AB_Split_Opts
AddUserResponseModel
CampaignResponseModel
Campaign_Defaults
Capsule
Contact
CreateNewListResponseModel
Daily_Send
Delivery_Status
FirstAndLastName
GetAllMembersResponseModel
GetListsResponseModel
GetMembersResponseModel
Highrise
Last_Note

1320 | P a g e
 MailChimp

Link
Location
MemberResponseModel
NewCampaignRequest
NewListRequest
NewMemberInListRequest
Recipient
Report_Summary
RSS_Opts
Salesforce
Schedule
Segment_Opts
Settings
Social_Card
Stats
Tracking
UpdateMemberInListRequest
Variate_Settings

Actions:
newcampaign
Summary: New Campaign
Description: Create a new campaign based on a Campaign Type, Recipients list and
Campaign Settings (subject line, title, from_name and reply_to)

Syntax:
MailChimp.newcampaign (NewCampaignRequest newCampaignRequest)

1321 | P a g e
 MailChimp

Parameters:
Name Type Summary Required Related
Action
newCampaignRequest NewCampaignRequest Body True
parameters
to create a
new
campaign

Returns:
Type:CampaignResponseModel
Description: New Campaign Result Model

GetLists
Summary: Get all the lists
Description: Find all the lists for the current user

Syntax:
MailChimp.GetLists ()

Returns:
Type:GetListsResponseModel
Description: Response when getting lists

newlist
Summary: New List
Description: Create a new list in your MailChimp account

Syntax:

1322 | P a g e
 MailChimp

MailChimp.newlist (NewListRequest newListRequest)

Parameters:
Name Type Summary Required Related
Action
newListRequest NewListRequest Body True
parameters to
create a new
campaign

Returns:
Type:CreateNewListResponseModel
Description: Create New List Result Model

GetListMembers
Summary: Show list members
Description: Show all the members of a list

Syntax:
MailChimp.GetListMembers (string list_id)

Parameters:
Name Type Summary Required Related
Action
list_id string The unique id for True GetLists
(List Id) the list

Returns:
Type:GetAllMembersResponseModel

1323 | P a g e
 MailChimp

Description: Response when querying for all members in a list

addmember
Summary: Add member to list
Description: Add or update a list member

Syntax:
MailChimp.addmember (string list_id, NewMemberInListRequest
newMemberInList)

Parameters:
Name Type Summary Required Related
Action
list_id string The unique True GetLists
(List Id) id for the
list
newMemberInList NewMemberInListRequest Add a new True
member to
the list

Returns:
Type:MemberResponseModel
Description: Member Result Model

removemember
Summary: Remove Member from list (V1)
Description: Delete a member from a list. (V1)

Syntax:

1324 | P a g e
 MailChimp

MailChimp.removemember (string list_id, string member_email)

Parameters:
Name Type Summary Required Related Action
list_id string The unique id True GetLists
(List Id) for the list
member_email string The email True GetListMembers
(Member address of the
email) member to
delete

Returns:

updatemember
Summary: Update member information. (V1)
Description: Update information for a specific list member (V1)

Syntax:
MailChimp.updatemember (string list_id, string member_email,
UpdateMemberInListRequest updateMemberInListRequest)

Parameters:
Name Type Summar Requir Related
y ed Action
list_id string The True GetLists
(List Id) unique
id for
the list

1325 | P a g e
 MailChimp

member_email string The True GetListMem

(Member email) unique bers
email
address
of the
member
to
update
updateMemberInListR UpdateMemberInListR Body True
equest equest paramet
ers to
update a
member
in a list

Returns:
Type:MemberResponseModel
Description: Member Result Model

removemember_v2
Summary: Remove Member from list (V2)
Description: Delete a member from a list. (V2)

Syntax:
MailChimp.removemember_v2 (string list_id, string member_email)

Parameters:
Name Type Summary Required Related Action

1326 | P a g e
 MailChimp

list_id string The unique id True GetLists

(List Id) for the list
member_email string The email True GetListMembers
(Member address of the
email) member to
delete

Returns:

updatemember_v2
Summary: Update member information (V2)
Description: Update information for a specific list member. (V2)

Syntax:
MailChimp.updatemember_v2 (string list_id, string member_email,
UpdateMemberInListRequest updateMemberInListRequest)

Parameters:
Name Type Summar Requir Related
y ed Action
list_id string The True GetLists
(List Id) unique
id for
the list
member_email string The True GetListMem
(Member email) unique bers
email
address
of the

1327 | P a g e
 MailChimp

member
to
update
updateMemberInListR UpdateMemberInListR Body True
equest equest paramet
ers to
update a
member
in a list

Returns:
Type:MemberResponseModel
Description: Member Result Model

Triggers:
Trigger OnMemberSubscribed
Summary: When a Member has been added to a list
Description: Triggers a workflow when a new member has been added to a list

Syntax:
MailChimp.OnMemberSubscribed (string list_id)

Parameters:
Name Type Summary Required Related
Action
list_id string The unique id for True GetLists
(List ID) the list

Returns:

1328 | P a g e
 MailChimp

Type:GetMembersResponseModel
Description: Response when getting members in a list

Trigger OnCreateList
Summary: When a new list is created
Description: Triggers a workflow when a new list is created

Syntax:
MailChimp.OnCreateList ()

Returns:
Type:GetListsResponseModel
Description: Response when getting lists

1329 | P a g e
 MailChimp

AB_Split_Opts
Summary:
Description: A/B Testing options for a campaign

Properties:
Name Type Summary
split_test string The type of AB split to
Split Test run
pick_winner string How we should evaluate
Pick Winner a winner. Based on
'opens', 'clicks', or
'manual'
wait_units string How unit of time for
Wait Time measuring the winner
('hours' or 'days'). This
cannot be changed after
a campaign is sent
wait_time integer(int32) The amount of time to
Wait Time wait before picking a
winner. This cannot be
changed after a campaign
is sent
split_size integer(int32) The size of the split
Split Size groups. Campaigns split
based on 'schedule' are
forced to have a 50/50
split. Valid split integers
are between 1-50

1330 | P a g e
 MailChimp

from_name_a string For campaigns split on

From Name Group A 'From Name', the name
for Group A
from_name_b string For campaigns split on
From Name Group B 'From Name', the name
for Group B
reply_email_a string For campaigns split on
Reply Email Group A ‘From Name’, the reply-to
address for Group A
reply_email_b string For campaigns split on
Reply Email Group B ‘From Name’, the reply-to
address for Group B
subject_a string For campaigns split on
Subject Line Group A ‘Subject Line’, the subject
line for Group A
subject_b string For campaigns split on
Subject Line Group B ‘Subject Line’, the subject
line for Group B
send_time_a string The send time for Group
Send Time Group A A
send_time_b string The send time for Group
Send Time Group B B
send_time_winner string The send time for the
Send Time Winner winning version

1331 | P a g e
 MailChimp

AddUserResponseModel
Summary:
Description: New Campaign Result Model

Properties:
Name Type Summary
id string The MD5 hash of the
Email ID lowercase version of the
list member’s email
address
email_address string Email address for a
Email Address subscriber
unique_email_id string An identifier for the
Unique Email ID address across all of
MailChimp
email_type string Type of email this
Email Type member asked to get
(‘html’ or ‘text’).
status string Subscriber’s current
Status status. Possible Values:
subscribed, unsubscribed,
cleaned, pending
merge_fields FirstAndLastName Merged fields containing
User First name and last
name
stats Stats Stats for the list. Many of
these are cached for at
least five minutes

1332 | P a g e
 MailChimp

ip_signup string IP address the subscriber

Signup IP signed up from
timestamp_signup string Date and time the
Signup Timestamp subscriber signed up for
the list
ip_opt string The IP address the
Opt-in IP subscriber used to
confirm their opt-in
status
timestamp_opt string Date and time the
Opt-in Timestamp subscribe confirmed their
opt-in status
member_rating integer(int32) Star rating for this
Member Rating member, between 1 and
5
last_changed string Date and time the
Last Changed Date member’s info was last
changed
language string If set/detected, the
Language subscriber’s language
vip boolean VIP status for subscriber
VIP
email_client string The list member’s email
Email Client client
location Location Subscriber location
information
last_note Last_Note THe most recent Note
added about this member
list_id string The list id

1333 | P a g e
 MailChimp

List ID
_links array of (Link) A list of link types and
Links descriptions for the API
schema documents

1334 | P a g e
 MailChimp

CampaignResponseModel
Summary:
Description: New Campaign Result Model

Properties:
Name Type Summary
id string A string that uniquely
Campaign ID identifies this campaign
type string There are four types of
Campaign Type campaigns you can create
in MailChimp. A/B Split
campaigns have been
deprecated and variate
campaigns should be used
instead Values: [, regular,
plaintext, absplit, rss,
variate]
create_time string The date and time the
Create Time campaign was created
archive_url string The link to the campaign’s
Archive URL archive version
status string The link to the campaign’s
Status archive version
emails_sent integer(int32) The total number of
Emails Sent emails sent for this
campaign
send_time string The time and date a
Send Time campaign was sent

1335 | P a g e
 MailChimp

content_type string How the campaign’s

Content Type content is put together
(‘template’,
‘drag_and_drop’, ‘html’,
‘url’)
recipient array of (Recipient) List settings for the
List campaign
settings Settings Settings for the campaign

variate_settings Variate_Settings Settings for the campaign

tracking Tracking Settings for the campaign

rss_opts RSS_Opts RSS options for a

campaign
ab_split_opts AB_Split_Opts A/B Testing options for a
campaign
social_card Social_Card Settings for the campaign

report_summary Report_Summary For sent campaigns, a

summary of opens, clicks,
and unsubscribes
delivery_status Delivery_Status Updates on campaigns in
the process of sending
_links array of (Link) A list of link types and
descriptions for the API
schema documents

1336 | P a g e
 MailChimp

Campaign_Defaults
Summary:
Description: Capsule tracking options for a campaign. Must be using MailChimp’s built-
in Capsule integration

Properties:
Name Type Summary
from_name string The default from name for
Sender's Name campaigns sent to this list
from_email string The default from email for
Sender's Email Address campaigns sent to this list
subject string The default subject line
Subject for campaigns sent to this
list
language string The default language for
Language this lists’s forms Values: [,
en, ar, af, be, bg, ca, zh,
hr, cs, da, nl, et, fa, fi, fr,
fr_CA, de, el, he, hi, hu, is,
id, ga, it, ja, km, ko, lv, lt,
mt, ms, mk, no, pl, pt,
pt_PT, ro, ru, sr, sk, sl, es,
es_ES, sw, sv, ta, th, tr, uk,
vi]

1337 | P a g e
 MailChimp

Capsule
Summary:
Description: Capsule tracking options for a campaign. Must be using MailChimp’s built-
in Capsule integration

Properties:
Name Type Summary
notes boolean Update contact notes for a
Capsule Note campaign based on
subscriber email addresses

1338 | P a g e
 MailChimp

Contact
Summary:
Description: Capsule tracking options for a campaign. Must be using MailChimp’s built-
in Capsule integration

Properties:
Name Type Summary
company string The company name for
Company Name the list
address1 string The street address for the
Address Line 1 list contact
address2 string The street address for the
Address Line 2 list contact
city string The city for the list contact
City
state string The state for the list
State contact
zip string The postal or zip code for
Postal Code the list contact
country string A two-character ISO3166
Country Code country code. Defaults to
US if invalid
phone string The phone number for the
Phone Number list contact

1339 | P a g e
 MailChimp

CreateNewListResponseModel
Summary:
Description: Create New List Result Model

Properties:
Name Type Summary
id string A string that uniquely
List ID identifies this list
name string The name of the list
List Name
contact Contact Capsule tracking options
for a campaign. Must be
using MailChimp’s built-
in Capsule integration
permission_reminder string The permission reminder
Permission Reminder for the list
use_archive_bar boolean Whether campaigns for
Use Archive Bar this list use the Archive
Bar in archives by default
campaign_defaults Campaign_Defaults Capsule tracking options
for a campaign. Must be
using MailChimp’s built-
in Capsule integration
notify_on_subscribe string The email address to
Notify on Subscribe send subscribe
notifications to
notify_on_unsubscribe string The email address to
Notify on Unsubscribe send unsubscribe
notifications to

1340 | P a g e
 MailChimp

date_created string The date and time that

Creation Date this list was created
list_rating integer(int32) An auto-generated
List Rating activity score for the list
(0-5)
email_type_option boolean Whether the list
Email Type Option supports multiple
formats for emails.When
set to true, subscribers
can choose whether they
want to receive HTML or
plain-text emails.When
set to false, subscribers
will receive HTML emails,
with a plain-text
alternative backup
subscribe_url_short string Our EepURL shortened
Subscribe URL Short version of this list’s
subscribe form
subscribe_url_long string The full version of this
Subscribe URL Long list’s subscribe form
(host will vary)
beamer_address string The list’s Email Beamer
Beamer Address address
visibility string Whether this list is public
Visibility or private
modules array of (string) Any list-specific modules
Modules installed for this list

1341 | P a g e
 MailChimp

stats Stats Stats for the list. Many of

these are cached for at
least five minutes
_links array of (Link) A list of link types and
Links descriptions for the API
schema documents

1342 | P a g e
 MailChimp

Daily_Send
Summary:
Description: The days of the week to send a daily RSS Campaign.

Properties:
Name Type Summary
sunday boolean Sends the daily RSS
Sunday Campaign on Sundays
monday boolean Sends the daily RSS
Monday Campaign on Mondays
tuesday boolean Sends the daily RSS
Tuesday Campaign on Tuesdays
wednesday boolean Sends the daily RSS
Wednesday Campaign on Wednesdays
thursday boolean Sends the daily RSS
Thursday Campaign on Thursdays
friday boolean Sends the daily RSS
Friday Campaign on Fridays
saturday boolean Sends the daily RSS
Saturday Campaign on Saturdays

1343 | P a g e
 MailChimp

Delivery_Status
Summary:
Description: Updates on campaigns in the process of sending

Properties:
Name Type Summary
enabled boolean Whether Campaign
Delivery Staut Enabled Delivery Status is enabled
for this account and
campaign
can_cancel boolean Whether a campaign
Campaign Cancelable send can be canceled
status string The current state of a
Campaign Delivery Status campaign delivery
emails_sent integer(int32) The total number of
Emails Sent emails confirmed sent for
this campaign so far
emails_canceled integer(int32) The total number of
Emails Canceled emails canceled for this
campaign

1344 | P a g e
 MailChimp

FirstAndLastName
Summary:
Description: Merged fields containing User First name and last name

Properties:
Name Type Summary
FNAME string First name of the
First Name subscriber
LNAME string Last name of the
Last Name subscriber

1345 | P a g e
 MailChimp

GetAllMembersResponseModel
Summary:
Description: Response when querying for all members in a list

Properties:
Name Type Summary
members array of An array of objects, each
(MemberResponseModel) representing a specific
Members list member
list_id string The list id
List Id
total_items integer(int32) The total number of
Total Items items matching the query
regardless of pagination

1346 | P a g e
 MailChimp

GetListsResponseModel
Summary:
Description: Response when getting lists

Properties:
Name Type Summary
lists array of An array of objects,
(CreateNewListResponseModel) each representing a list
Lists
total_items integer(int32) The total number of
Item Count items matching the
query regardless of
pagination

1347 | P a g e
 MailChimp

GetMembersResponseModel
Summary:
Description: Response when getting members in a list

Properties:
Name Type Summary
members array of An array of objects, each
(AddUserResponseModel) representing a specific
Members list member
list_id string The list id
List ID
total_items integer(int32) The total number of
Item Count items matching the query
regardless of pagination

1348 | P a g e
 MailChimp

Highrise
Summary:
Description: Highrise tracking options for a campaign. Must be using MailChimp’s
built-in Highrise integration

Properties:
Name Type Summary
campaign boolean Create a campaign in a
Highrise Campaign connected Highrise
account
notes boolean Update contact notes for a
Highrise Note campaign based on
subscriber email
addresses

1349 | P a g e
 MailChimp

Last_Note
Summary:
Description: THe most recent Note added about this member

Properties:
Name Type Summary
note_id integer(int32) The note id
Note ID
created_at string The date the note was
Created Time created
created_by string The author of the note
Author
note string The content of the note
Note

1350 | P a g e
 MailChimp

Link
Summary:
Description: Capsule tracking options for a campaign. Must be using MailChimp’s built-
in Capsule integration

Properties:
Name Type Summary
rel string As with an HTML ‘rel’
Rel attribute, this describes
the type of link
href string This property contains a
Href fully-qualified URL that
can be called to retrieve
the linked resource or
perform the linked action
method string The HTTP method that
Method should be used when
accessing the URL defined
in ‘href’. (GET, POST, PUT,
PATCH, DELETE, OPTIONS,
HEAD)
targetSchema string For GETs, this is a URL
Target Schema representing the schema
that the response should
conform to
schema string For HTTP methods that
Schema can receive bodies (POST
and PUT), this is a URL
representing the schema

1351 | P a g e
 MailChimp

that the body should

conform to

1352 | P a g e
 MailChimp

Location
Summary:
Description: Subscriber location information

Properties:
Name Type Summary
latitude number(float) The location latitude
Latitude
longitude number(float) The location longitude
Longitude

1353 | P a g e
 MailChimp

MemberResponseModel
Summary:
Description: Member Result Model

Properties:
Name Type Summary
id string The MD5 hash of the
Email ID lowercase version of the
list member’s email
address
email_address string Email address for a
Email Address subscriber
unique_email_id string An identifier for the
Unique Email ID address across all of
MailChimp
email_type string Type of email this
Email Type member asked to get
(‘html’ or ‘text’).
status string Subscriber’s current
Status status. Possible Values:
subscribed, unsubscribed,
cleaned, pending
merge_fields FirstAndLastName Merged fields containing
User First name and last
name
stats Stats Stats for the list. Many of
these are cached for at
least five minutes

1354 | P a g e
 MailChimp

ip_signup string IP address the subscriber

Signup IP signed up from
timestamp_signup string Date and time the
Signup Timestamp subscriber signed up for
the list
ip_opt string The IP address the
Opt-in IP subscriber used to
confirm their opt-in
status
timestamp_opt string Date and time the
Opt-in Timestamp subscribe confirmed their
opt-in status
member_rating integer(int32) Star rating for this
Member Rating member, between 1 and
5
last_changed string Date and time the
Last Changed Date member’s info was last
changed
language string If set/detected, the
Language subscriber’s language
vip boolean VIP status for subscriber
VIP
email_client string The list member’s email
Email Client client
location Location Subscriber location
information
last_note Last_Note THe most recent Note
added about this member
list_id string The list id

1355 | P a g e
 MailChimp

List ID
_links array of (Link) A list of link types and
Links descriptions for the API
schema documents

1356 | P a g e
 MailChimp

NewCampaignRequest
Summary:
Description: Body parameters to create a new campaign

Properties:
Name Type Summary
type string There are four types of
Campaign Type campaigns you can create
in MailChimp. A/B Split
campaigns have been
deprecated and variate
campaigns should be
used instead. Possible
Values: regular, plaintext,
absplit, rss, variate
Values: [, regular,
plaintext, absplit, rss,
variate]
recipients Recipient Settings for the campaign

settings Settings Settings for the campaign

variate_settings Variate_Settings Settings for the campaign

tracking Tracking Settings for the campaign

rss_opts RSS_Opts RSS options for a

campaign
social_card Social_Card Settings for the campaign

1357 | P a g e
 MailChimp

1358 | P a g e
 MailChimp

NewListRequest
Summary:
Description: Body parameters to create a new campaign

Properties:
Name Type Summary
name string The name of the list
List Name
contact Contact Capsule tracking options
for a campaign. Must be
using MailChimp’s built-
in Capsule integration
permission_reminder string Text to remind people
Permission Reminder how they signed up to
this list
use_archive_bar boolean Whether campaigns for
Use Archive Bar this list use the Archive
Bar in archives by default
campaign_defaults Campaign_Defaults Capsule tracking options
for a campaign. Must be
using MailChimp’s built-
in Capsule integration
notify_on_subscribe string The email address to
Notify on Subscribe send subscribe
notifications to
notify_on_unsubscribe string The email address to
Notify on Unsubscribe send unsubscribe
notifications to

1359 | P a g e
 MailChimp

email_type_option boolean When set to true,

Allow users to choose subscribers can choose
between HTML and Plain whether they want to
text (true/false)? receive HTML or plain-
text emails. When set to
false, subscribers will
receive HTML emails,
with a plain-text
alternative backup
visibility string Whether this list is public
Visibility or private Values: [, pub,
prv]

1360 | P a g e
 MailChimp

NewMemberInListRequest
Summary:
Description: Add a new member to the list

Properties:
Name Type Summary
email_type string Type of email this
Email Type member asked to get
(‘html’ or ‘text’) Values: [,
html, text]
status string Subscriber’s current
Status status. Possible Values:
subscribed, unsubscribed,
cleaned, pending Values:
[, subscribed,
unsubscribed, cleaned,
pending]
merge_fields FirstAndLastName Merged fields containing
User First name and last
name
language string If set/detected, the
Language subscriber’s language
vip boolean VIP status for subscriber
VIP
location Location Subscriber location
information
email_address string Email address for a
Email Address subscriber

1361 | P a g e
 MailChimp

Recipient
Summary:
Description: Settings for the campaign

Properties:
Name Type Summary
list_id string The unique list id
List Id
segment_opts Segment_Opts An object representing all
segmentation options

1362 | P a g e
 MailChimp

Report_Summary
Summary:
Description: For sent campaigns, a summary of opens, clicks, and unsubscribes

Properties:
Name Type Summary
opens integer(int32) The total number of
Automation Opens opens for a campaign
unique_opens integer(int32) The number of unique
Unique Opens opens
open_rate number(float) The number of unique
Open Rate opens divided by the total
number of successful
deliveries
clicks integer(int32) The total number of clicks
Total Clicks for an campaign
subscriber_clicks number(float) The number of unique
Unique Subscriber Clicks clicks
click_rate number(float) The number of unique
Click Rate clicks divided by the total
number of successful
deliveries

1363 | P a g e
 MailChimp

RSS_Opts
Summary:
Description: RSS options for a campaign

Properties:
Name Type Summary
feed_url string The URL for the RSS feed
Feed URL
frequency string The frequency of the RSS
Frequency Campaign Values: [, daily,
weekly, monthly]
constrain_rss_img string Whether to add CSS to
Constrain RSS Images images in the RSS feed to
constrain their width in
campaigns
schedule Schedule The schedule for sending
the RSS Campaign

1364 | P a g e
 MailChimp

Salesforce
Summary:
Description: Salesforce tracking options for a campaign. Must be using MailChimp’s
built-in Salesforce integration

Properties:
Name Type Summary
campaign boolean Create a campaign in a
Salesforce Campaign connected Salesforce
account
notes boolean Update contact notes for a
Salesforce Note campaign based on
subscriber email
addresses

1365 | P a g e
 MailChimp

Schedule
Summary:
Description: The schedule for sending the RSS Campaign

Properties:
Name Type Summary
hour integer(int32) The hour to send the
Sending Hour campaign in local time.
Acceptable hours are 0-
23. For example, ‘4’
would be 4am in your
account’s default time
zone
daily_send Daily_Send The days of the week to
send a daily RSS
Campaign.
weekly_send_day string The day of the week to
Weekly Sending Day send a weekly RSS
Campaign Values: [,
sunday, monday,
tuesday, wednesday,
thursday, friday,
saturday]
monthly_send_date number(float) The day of the month to
Monthly Sending Day send a monthly RSS
Campaign. Acceptable
days are 1-32, where ‘0’ is
always the last day of a
month. Months with

1366 | P a g e
 MailChimp

fewer than the selected

number of days will not
have an RSS campaign
sent out that day. For
example, RSS Campaigns
set to send on the 30th
will not go out in
February

1367 | P a g e
 MailChimp

Segment_Opts
Summary:
Description: An object representing all segmentation options

Properties:
Name Type Summary
saved_segment_id integer(int32) The id for an existing
Saved Segment ID saved segment
match string Segment match type:
Match Type Possible Values: any, all

1368 | P a g e
 MailChimp

Settings
Summary:
Description: Settings for the campaign

Properties:
Name Type Summary
subject_line string The subject line for the
Campaign Subject Line campaign
title string The title of the campaign
Title
from_name string The 'from' name on the
From Name campaign (not an email
address)
reply_to string The reply-to email
Reply To Address address for the campaign
use_conversation boolean Use MailChimp
Conversation Conversation feature to
manage out-of-office
replies
to_name string The campaign's custom
To Name 'To' name. Typically the
first name merge field
folder_id integer(int32) If the campaign is listed in
Folder ID a folder, the id for that
folder
authenticate boolean Whether MailChimp
Authentication authenticated the
campaign. Defaults to
true

1369 | P a g e
 MailChimp

auto_footer boolean Automatically append

Auto-Footer MailChimp's default
footer to the campaign
inline_css boolean Automatically inline the
Inline CSS CSS included with the
campaign content
auto_tweet boolean Automatically tweet a link
Auto-Tweet to the campaign archive
page when the campaign
is sent
auto_fb_post array of (integer(int32)) An array of Facebook
Auto Post to Facebook page ids to auto-post to
fb_comments boolean Allows Facebook
Facebook Comments comments on the
campaign (also force-
enables the Campaign
Archive toolbar). Defaults
to true

1370 | P a g e
 MailChimp

Social_Card
Summary:
Description: Settings for the campaign

Properties:
Name Type Summary
image_url string The url for the header
Image URL image for the card
description string A short summary of the
Campaign Description campaign to display
title string The title for the card.
Title Typically the subject line
of the campaign

1371 | P a g e
 MailChimp

Stats
Summary:
Description: Stats for the list. Many of these are cached for at least five minutes

Properties:
Name Type Summary
member_count integer(int32) The number of active
Member Count members in the list
unsubscribe_count integer(int32) The number of
Unsubscribe Count members who have
unsubscribed from the
list
cleaned_count integer(int32) The number of
Cleaned Count members cleaned from
the list
member_count_since_send integer(int32) The number of active
Member Count Since members in the list
Send since the last campaign
was sent
unsubscribe_count_since_send integer(int32) The number of
Unsubscribe Count members who have
Since Send unsubscribed since the
last campaign was sent
cleaned_count_since_send integer(int32) The number of
Cleaned Count Since members cleaned from
Send the list since the last
campaign was sent

1372 | P a g e
 MailChimp

campaign_count integer(int32) The number of

Campaign Count campaigns in any status
that use this list
campaign_last_sent integer(int32) The date and time the
Campaign Last Sent last campaign was sent
to this list
merge_field_count integer(int32) The number of merge
Merge Var Count vars for this list (not
EMAIL, which is
required)
avg_sub_rate number(float) The average number of
Average Subscription subscriptions per month
Rate for the list(not returned
if we haven’t calculated
it yet)
avg_unsub_rate number(float) The average number of
Average Unsubscription unsubscriptions per
Rate month for the list(not
returned if we haven’t
calculated it yet)
target_sub_rate number(float) The target number of
Target Subscription subscriptions per month
Rate for the list to keep it
growing(not returned if
we haven’t calculated it
yet)
open_rate number(float) The average open rate(a
Open Rate percentage represented
as a number between 0

1373 | P a g e
 MailChimp

and 100) per campaign

for the list(not returned
if we haven’t calculated
it yet)
click_rate number(float) The average click rate(a
Click Rate percentage represented
as a number between 0
and 100) per campaign
for the list(not returned
if we haven’t calculated
it yet)
last_sub_date string The date and time of
Date of Last List the last time someone
Subscribe subscribed to this list
last_unsub_date string The date and time of
Date of Last List the last time someone
Unsubscribe unsubscribed from this
list

1374 | P a g e
 MailChimp

Tracking
Summary:
Description: Settings for the campaign

Properties:
Name Type Summary
opens boolean Whether to track opens.
Opens Defaults to true. Cannot
be set to false for variate
campaigns
html_clicks boolean Whether to track clicks in
HTML Click Tracking the HTML version of the
campaign. Defaults to
true. Cannot be set to
false for variate
campaigns
text_clicks boolean Whether to track clicks in
Plain-Text Click Tracking the plain-text version of
the campaign. Defaults to
true. Cannot be set to
false for variate
campaigns
goal_tracking boolean Whether to enable Goal
MailChimp Goal Tracking tracking
ecomm360 boolean Whether to enable
eCommerce360 Tracking eCommerce360 tracking
google_analytics string The custom slug for
Google Analytics Tracking Google Analytics tracking
(max of 50 bytes)

1375 | P a g e
 MailChimp

clicktale string The custom slug for

ClickTale Analytics ClickTale tracking (max of
Tracking 50 bytes)
salesforce Salesforce Salesforce tracking
options for a campaign.
Must be using
MailChimp’s built-in
Salesforce integration
highrise Highrise Highrise tracking options
for a campaign. Must be
using MailChimp’s built-in
Highrise integration
capsule Capsule Capsule tracking options
for a campaign. Must be
using MailChimp’s built-in
Capsule integration

1376 | P a g e
 MailChimp

UpdateMemberInListRequest
Summary:
Description: Body parameters to update a member in a list

Properties:
Name Type Summary
email_address string Email address for a
Email Address subscriber
email_type string Type of email this
Email Type member asked to get
(‘html’ or ‘text’) Values: [,
html, text]
status string Subscriber’s current
Status status. Possible Values:
subscribed, unsubscribed,
cleaned, pending Values:
[, subscribed,
unsubscribed, cleaned,
pending]
merge_fields FirstAndLastName Merged fields containing
User First name and last
name
language string If set/detected, the
Language subscriber’s language
vip boolean VIP status for subscriber
VIP
location Location Subscriber location
information

1377 | P a g e
 MailChimp

Variate_Settings
Summary:
Description: Settings for the campaign

Properties:
Name Type Summary
winner_criteria string The combination that
Winning Criteria performs the best. This
may be determined
automatically by click rate,
open rate, or total
revenue—or you may
choose manually based on
the reporting data you find
the most valuable. For
Multivariate Campaigns
testing send_time,
winner_critera is ignored.
For Multivariate
Campaigns with 'manual'
as the winner_citeria, the
winner must be chosen in
the MailChimp web
application
wait_time integer(int32) The number of minutes to
Wait Time wait before choosing the
winning campaign. The
value of wait_time must be
greater than 0 and in

1378 | P a g e
 MailChimp

whole hours, specified in

minutes
test_size integer(int32) The percentage of
Test Size recipients to send the test
combinations to, must be a
value between 10 and 100
subject_lines array of (string) The possible subject lines
Subject Lines to test. If no subject lines
are provided,
settings.subject_line will
be used
send_times array of (string) The possible send times to
Send Times test. The times provided
should be in the format
YYYY-MM-DD HH:MM:SS.
If send_times are provided
to test, the test_size will
be set to 100% and
winner_criteria will be
ignored
from_names array of (string) The possible from names.
From Names The number of
from_names provided
must match the number of
reply_to_addresses. If no
from_names are provided,
settings.from_name will be
used

1379 | P a g e
 MailChimp

reply_to_addresses array of (string) The possible from names.

Reply To Addresses The number of
from_names provided
must match the number of
reply_to_addresses. If no
from_names are provided,
settings.from_name will be
used

1380 | P a g e
 Mandrill

Mandrill
Mandrill is a transactional email API for MailChimp users. It's reliable,
powerful, and ideal for sending data driven emails, including targeted e-
commerce and personalized one-to-one messages.

Status: Production Tier: Premium Version: 1.0

Actions:
Name Summary
CurrentUser () Current user info
SentMessageInfo (string Id) Recently sent message
SendMessage Send mail
(SendMessageRequest
sendMessageRequest)
ScheduledMessageInfo List scheduled message
(ListScheduledRequest
listScheduledRequest)

Triggers:
Name Summary

Objects:
Name Summary
AttachmentInfo
ClickInfo
ListScheduledInfo
ListScheduledRequest

1381 | P a g e
 Mandrill

MessageInfo
OpenedDetail
RecipientInfo
SendMessageInfo
SendMessageRequest
SendMessageResponse
SmtpEventInfo
Stats
StatStruct
TagInfo
UserInfo

Actions:
CurrentUser
Summary: Current user info
Description: Return the information about the API-connected user

Syntax:
Mandrill.CurrentUser ()

Returns:
Type:UserInfo
Description: the user information including username, key, reputation, quota,
and historical sending stats

SentMessageInfo
Summary: Recently sent message
Description: Get the information for a single recently sent message

1382 | P a g e
 Mandrill

Syntax:
Mandrill.SentMessageInfo (string Id)

Parameters:
Name Type Summary Required Related
Action
Id string True

Returns:
Type:MessageInfo
Description: Information for the message

SendMessage
Summary: Send mail
Description: Send a new transactional message through Mandrill

Syntax:
Mandrill.SendMessage (SendMessageRequest sendMessageRequest)

Parameters:
Name Type Summary Required Related
Action
sendMessageRequest SendMessageRequest Information True
for the
message for
each
recipient

1383 | P a g e
 Mandrill

containing
the key
"email" with
the email
address, and
details of the
message
status for
that
recipient

Returns:
Type:array of (SendMessageResponse)

ScheduledMessageInfo
Summary: List scheduled message
Description: Queries your scheduled emails

Syntax:
Mandrill.ScheduledMessageInfo (ListScheduledRequest
listScheduledRequest)

Parameters:
Name Type Summary Required Related
Action
listScheduledRequest ListScheduledRequest Parameters True
to restrict list
of scheduled

1384 | P a g e
 Mandrill

emails
search

Returns:
Type:array of (ListScheduledInfo)

1385 | P a g e
 Mandrill

AttachmentInfo
Summary:
Description: Information for the message

Properties:
Name Type Summary
type string MIME type of the
MIME Type attachment
name string File name of the
File Name attachment
content string(byte) Content of the attachment
Content

1386 | P a g e
 Mandrill

ClickInfo
Summary:
Description: Information on an individual click

Properties:
Name Type Summary
ts integer(int32) Unix timestamp from
Time Stamp when the message was
clicked
url string URL that was clicked on
Clicked URL
ip string IP address that generated
IP Address the click
location string Approximate region and
Location country that the clicking IP
is located
ua string Email client of browser
Opening Browser data of the click

1387 | P a g e
 Mandrill

ListScheduledInfo
Summary:
Description: Information about a specific smtp event

Properties:
Name Type Summary
email string Email address of the
Recipient's Email recipient
status string Sending status of the
Recipient's Status recipient - either "sent",
"queued", "scheduled",
"rejected", or "invalid"
Values: [, sent, queued,
scheduled, rejected, or
invalid]
reject_reason string Reason for the rejection if
Rejection Reason the recipient status is
"rejected" - one of "hard-
bounce", "soft-bounce",
"spam", "unsub",
"custom", "invalid-
sender", "invalid", "test-
mode-limit", "unsigned",
or "rule" Values: [, hard-
bounce, soft-bounce,
spam, unsub, custom,
invalid-sender, invalid,
test-mode-limit, unsigned,
or rule]

1388 | P a g e
 Mandrill

_id string Message's unique id

Message ID

1389 | P a g e
 Mandrill

ListScheduledRequest
Summary:
Description: Parameters to restrict list of scheduled emails search

Properties:
Name Type Summary
To string Optional recipient email
To address to restrict results
to

1390 | P a g e
 Mandrill

MessageInfo
Summary:
Description: Information for the message

Properties:
Name Type Summary
ts integer(int32) Unix timestamp from
Time Stamp when this message was
sent
_id string Message's unique id
Message ID
sender string Email address of the
Sender's Email sender
template string Unique name of the
Template Name template userd, if any
subject string Message's subject line
Subject
email string Recipient email address
Recipient's Email
tags array of (TagInfo) List of tags in this
Tags message
opens integer(int32) How many times has this
Opened message been opened
opens_details array of (OpenedDetail) List of individual opens
Opened Details for the message
clicks string How many times has a
Clicks link been clicked in this
message

1391 | P a g e
 Mandrill

clicks_detail array of (ClickInfo) List of individual clicks for

Click Details the message
state string Sending status of this
Sending State message: sent, bounced,
rejected Values: [, sent,
bounced, rejected]
smtp_events array of (SmtpEventInfo) Log of up to 3 smtp
SMTP Events events for the message

1392 | P a g e
 Mandrill

OpenedDetail
Summary:
Description: Information on an individual

Properties:
Name Type Summary
ts string Unix timestamp from
Time Stamp when the message was
opened
ip string IP address that generated
IP Address the open
location string Approximate region and
Location country that the opening
IP is located
ua string Email client of browser
Opening Browser data of the open

1393 | P a g e
 Mandrill

RecipientInfo
Summary:
Description: Single recipient's information

Properties:
Name Type Summary
email string Email address of the
Email recipient
name string Display name of the
Name recipient
type string Send type (to, cc, bcc)
Send As Values: [to, cc, bcc]

1394 | P a g e
 Mandrill

SendMessageInfo
Summary:
Description: Information on the message to send

Properties:
Name Type Summary
html string Full HTML content to be
HTML Text sent
text string Full text content to be
Text content of the sent
message
subject string Message subject
Subject
from_email string Sender email address
From Email
from_name string Sender email name
From Name
to array of (RecipientInfo) Array of recipients
Send To
headers string Extra headers to add to
Extra headers the message (most
headers are allowed)
important boolean Whether or not this
Is this message Important message is important, and
(true/false)? should be delivered ahead
of non-important
messages

1395 | P a g e
 Mandrill

track_opens boolean Whether or not to turn on

Track when message open tracking for the
opens (true/false)? message
track_clicks boolean Whether or not to turn on
Track clicks for this click tracking for the
message (true/false)? message
auto_text boolean Whether or not to
Fill text message if not automatically generate a
present (true/false)? text part for messages
that are not given text
auto_html boolean Whether or not to
Fill HTML message if not automatically generate an
present (true/false)? HTML part for messages
that are not given HTML
inline_css boolean Whether or not to
Inline CSS Styles in Html automatically inline all
message (true/false)? CSS styles provided in the
message HTML - only for
HTML documents less
than 256KB in size
url_strip_qs boolean Whether or not to strip
Strip query string from the query string from
URL in aggregated data URLs when aggregating
(true/false)? tracked URL data
preserve_recipients boolean Whether or not to expose
Show all recipients in 'To' all recipients in to "To"
line (true/false)? header for each email
view_content_link boolean Whether or not to log
content. Set to false to

1396 | P a g e
 Mandrill

Remove content logging remove content logging

(true/false)? for sensitive emails
bcc_address string Optional address to
Optional BCC address receive an exact copy of
each recipient's email
tracking_domain string Custom domain to use for
Custom domaing for tracking opens and clicks
tracking instead of
mandrillapp.com
tags array of (string) Array of strings to tag the
Tags message with. Stats are
accumulated using tags,
though we only store the
first 100 we see, so this
should not be unique or
change frequently. Tags
should be 50 characters
or less. Any tags starting
with an underscore are
reserved for internal use
and will cause errors.
attachments array of (AttachmentInfo) Attachments to add to the
Attachments message

1397 | P a g e
 Mandrill

SendMessageRequest
Summary:
Description: Information for the message for each recipient containing the key "email"
with the email address, and details of the message status for that recipient

Properties:
Name Type Summary
message SendMessageInfo Information on the
message to send
send_at string When this message should
Send At be sent as a UTC
timestamp in YYYY-MM-
DD HH:MM:SS format. If
you specify a time in the
past, the message will be
sent immediately. An
additional fee applies for
scheduled email, and this
feature is only available to
accounts with a positive
balance.
async boolean Enable a background
Enable async (true/false)? sending mode that is
optimized for bulk sending
ip_pool string Name of the dedicated ip
Dedicated Ip Pool name pool that should be used
to send the message

1398 | P a g e
 Mandrill

SendMessageResponse
Summary:
Description: Information for the message for each recipient containing the key "email"
with the email address, and details of the message status for that recipient

Properties:
Name Type Summary
email string Email address of the
Email recipient
status string Sending status of the
Sending Status recipient - either "sent",
"queued", "scheduled",
"rejected", or "invalid"
reject_reason string Reason for the rejection if
Reject Reason the recipient status is
"rejected" - one of "hard-
bounce", "soft-bounce",
"spam", "unsub",
"custom", "invalid-
sender", "invalid", "test-
mode-limit", "unsigned",
or "rule
_id string message's unique id
Message ID

1399 | P a g e
 Mandrill

SmtpEventInfo
Summary:
Description: Information about a specific smtp event

Properties:
Name Type Summary
ts integer(int32) Unix timestamp when the
Time Stamp event occured
type string Message's state as a result
Message's State of this event
diag string SMTP response from the
SMTP Response recipient's server

1400 | P a g e
 Mandrill

Stats
Summary:
Description: aggregate summary of the account's sending stats

Properties:
Name Type Summary
today StatStruct Struct to hold stat
information, this struct is
shared across stats for
today, last_7_days,
last_30_days,
last_60_days,
last_90_days and all_time
last_7_days StatStruct Struct to hold stat
information, this struct is
shared across stats for
today, last_7_days,
last_30_days,
last_60_days,
last_90_days and all_time
last_30_days StatStruct Struct to hold stat
information, this struct is
shared across stats for
today, last_7_days,
last_30_days,
last_60_days,
last_90_days and all_time
last_60_days StatStruct Struct to hold stat
information, this struct is

1401 | P a g e
 Mandrill

shared across stats for

today, last_7_days,
last_30_days,
last_60_days,
last_90_days and all_time
last_90_days StatStruct Struct to hold stat
information, this struct is
shared across stats for
today, last_7_days,
last_30_days,
last_60_days,
last_90_days and all_time
all_time StatStruct Struct to hold stat
information, this struct is
shared across stats for
today, last_7_days,
last_30_days,
last_60_days,
last_90_days and all_time

1402 | P a g e
 Mandrill

StatStruct
Summary:
Description: Struct to hold stat information, this struct is shared across stats for today,
last_7_days, last_30_days, last_60_days, last_90_days and all_time

Properties:
Name Type Summary
sent integer(int32) Number of emails sent for
Sent this user
hard_bounces integer(int32) Number of emails hard
Hard Bounces bounced for this user
soft_bounces integer(int32) Number of emails soft
Soft Bounces bounced for this user
rejects integer(int32) Number of emails
Rejects rejected for sending this
user
complaints integer(int32) Number of spam
Complaints complaints for this user
unsubs integer(int32) Number of unsubscribes
Unsubscribes for this user
unique_opens integer(int32) Number of times emails
Unique Opens have been opened for this
user
clicks integer(int32) Number of URLS that have
Clicks been clicked for this user
so far today
unique_clicks integer(int32) Number of unique clicks
Unique Clicks for emails sent for this
user

1403 | P a g e
 Mandrill

1404 | P a g e
 Mandrill

TagInfo
Summary:
Description: Individual tag on a message

Properties:
Name Type Summary
tag string Individual tag on a
Tag message

1405 | P a g e
 Mandrill

UserInfo
Summary:
Description: the user information including username, key, reputation, quota, and
historical sending stats

Properties:
Name Type Summary
username string Username of the user
User Name (used for SMTP
authentication)
created_at string Date and time that the
Created at user's Mandrill account
was created as a UTC
string in YYYY-MM-DD
HH:MM:SS format
public_id string Unique, permanent
Public id identifier for this user
reputation integer(int32) Reputation of the user on
Reputation a scale from 0 to 100, with
75 generally being a
"good" reputation
hourly_quota integer(int32) Maximum number of
Hourly Quota emails Mandrill will deliver
for this user each hour.
Any emails beyond that
will be accepted and
queued for later delivery.
Users with higher

1406 | P a g e
 Mandrill

reputations will have

higher hourly quotas
backlog integer(int32) Number of emails that are
Backlog queued for delivery due to
exceeding your monthly or
hourly quotas
stats Stats aggregate summary of the
account's sending stats

1407 | P a g e
 Medium

Medium
Medium is a vibrant network of thinkers who care about the world and
making it better. Connect to your Medium account to track new publications,
write stories and more.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
WriteStory (WriteStoryParameterBody Write a story
body)
WriteStoryToPublication (string Write a story under a publication
publicationId,
WriteStoryToPublicationParameterBody
body)
PublicationsList () Publications for internal use

Triggers:
Name Summary
TriggerPublicationAdded () When a publication is created or subscribed to

Objects:
Name Summary
publications
WriteStoryParameterBody
WriteStoryResponse
WriteStoryToPublicationParameterBody

1408 | P a g e
 Medium

WriteStoryToPublicationResponse

Actions:
WriteStory
Summary: Write a story
Description: Write a new story.

Syntax:
Medium.WriteStory (WriteStoryParameterBody body)

Parameters:
Name Type Summary Required Related
Action
body WriteStoryParameterBody True

Returns:
Type:WriteStoryResponse

WriteStoryToPublication
Summary: Write a story under a publication
Description: Write a story under a publication.

Syntax:
Medium.WriteStoryToPublication (string publicationId,
WriteStoryToPublicationParameterBody body)

Parameters:

1409 | P a g e
 Medium

Name Type Summa Require Related

ry d Action
publication string True PublicationsL
Id (Publication) ist
body WriteStoryToPublicationParamete True
rBody

Returns:
Type:WriteStoryToPublicationResponse

PublicationsList
Summary: Publications for internal use
Description: List of Publications for internal use

Syntax:
Medium.PublicationsList ()

Returns:
Type:publications

Triggers:
Trigger TriggerPublicationAdded
Summary: When a publication is created or subscribed to
Description: Triggers a new flow when a publication is created or subscribed to

Syntax:
Medium.TriggerPublicationAdded ()

1410 | P a g e
 Medium

Returns:
Type:publications

1411 | P a g e
 Medium

publications
Summary:
Description:

Properties:
Name Type Summary
data array of (DataItem)
Publication

DataItem
Summary:
Description:

Properties:
Name Type Summary
id string The id of the publication.
Id
name string The name of the
Name publication.
description string The description of the
Description publication.
url string The URL to the publication
URL in Medium.
imageUrl string The image URL for the
Image Url publication.

1412 | P a g e
 Medium

WriteStoryParameterBody
Summary:
Description:

Properties:
Name Type Summary
title string
Title
contentFormat string

content string
Content (as html)
tags array of (string) Comma separated list of
Tags tags to add to the story
(max 3).
publishStatus string Values: [Draft, Public,
Publish Status Unlisted]

1413 | P a g e
 Medium

WriteStoryResponse
Summary:
Description:

Properties:
Name Type Summary
data Data
Story

Data
Summary: Story
Description:

Properties:
Name Type Summary
id string The id of the story.
Id
title string The story title.
Title
authorId string The author id of the story.
Author Id
url string The URL to the story in
URL Medium.
canonicalUrl string The canonical URL to the
Canonical URL story in Medium.
publishStatus string The publish status of the
Publish Status story, such as Draft or
Public.

1414 | P a g e
 Medium

license string The license associated

License with the story.
licenseUrl string The license URL
License Url associated with the story.
tags array of (string) An array of tags on the
Tags story.

1415 | P a g e
 Medium

WriteStoryToPublicationParameterBody
Summary:
Description:

Properties:
Name Type Summary
title string
Title
contentFormat string

content string
Content (as html)
tags array of (string) Comma separated list of
Tags tags to add to the story
(max 3).
publishStatus string Values: [Draft, Public,
Publish Status Unlisted]

1416 | P a g e
 Medium

WriteStoryToPublicationResponse
Summary:
Description:

Properties:
Name Type Summary
data Data
Story

Data
Summary: Story
Description:

Properties:
Name Type Summary
id string The id of the story.
Id
title string The title of the story.
Title
authorId string The id of the author of the
Author Id story.
url string The URL to the story in
URL Medium.
canonicalUrl string The canonical URL to the
Canonical Url story in Medium.
publishStatus string The publish status of the
Publish Status story, such as Draft or
Public.

1417 | P a g e
 Medium

license string The license associated

License with the story.
licenseUrl string The license URL
License Url associated with the story.
tags array of (string) An array of tags on the
Tags story.
publicationId string
Publication Id

1418 | P a g e
 Microsoft Translator

Microsoft Translator
Microsoft Translator lets you translate text

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
Languages () Get languages
Translate (string query, string Translate text
languageTo,
[advanced][Optional]string
languageFrom,
[advanced][Optional]string
category,
[advanced][Optional]string
contentType)
Detect (string query) Detect language
SpeechLanguages () Get speech languages
TextToSpeech (string query, Text to speech
string language,
[advanced][Optional]string
format,
[advanced][Optional]string
options)

Triggers:
Name Summary

1419 | P a g e
 Microsoft Translator

Objects:
Name Summary
Language

Actions:
Languages
Summary: Get languages
Description: Retrieves all languages that Microsoft Translator supports

Syntax:
MicrosoftTranslator.Languages ()

Returns:
Type:array of (Language)

Translate
Summary: Translate text
Description: Translates text to a specified language using Microsoft Translator

Syntax:
MicrosoftTranslator.Translate (string query, string languageTo,
[advanced][Optional]string languageFrom,
[advanced][Optional]string category, [advanced][Optional]string
contentType)

Parameters:
Name Type Summary Required Related
Action
query string Text to translate True

1420 | P a g e
 Microsoft Translator

(Text)
languageTo string Target language True Languages
(Target code (example:
language) 'fr')
languageFrom string Source language False Languages
(Source (if not provided,
Language) Microsoft
Translator will
try to auto-
detect)
(example: en)
category string Translation False
(Category) category
(default:
'general')
contentType string Content type False
(Content (default:
Type)Values: 'text/plain')
[text/plain,
text/html]

Returns:
Type:string
Summary: Translated text

Detect
Summary: Detect language
Description: Detects source language of given text

1421 | P a g e
 Microsoft Translator

Syntax:
MicrosoftTranslator.Detect (string query)

Parameters:
Name Type Summary Required Related
Action
query string Text to translate True
(Text)

Returns:
Type:Language
Description: Language Model for Microsoft Translator translatable languages

SpeechLanguages
Summary: Get speech languages
Description: Retrieves the languages available for speech synthesis

Syntax:
MicrosoftTranslator.SpeechLanguages ()

Returns:
Type:array of (Language)

TextToSpeech
Summary: Text to speech
Description: Converts a given text into speech as an audio stream in wave format

Syntax:

1422 | P a g e
 Microsoft Translator

MicrosoftTranslator.TextToSpeech (string query, string language,

[advanced][Optional]string format, [advanced][Optional]string
options)

Parameters:
Name Type Summary Required Related Action
query string Text to True
(Text) translate
language string Language True SpeechLanguages
(Language code to
Code) generate
speech
(example: 'en-
us')
format string Audio format False
(Format)Values: (default is
[audio/wav, audio/wav).
audio/mp3]
options string Options False
(Options)Values: (default is
[MinSize, MinSize).
MaxQuality]

Returns:
Type:string(binary)
Summary: Audio file

1423 | P a g e
 Microsoft Translator

Language
Summary:
Description: Language Model for Microsoft Translator translatable languages

Properties:
Name Type Summary
Code string Gets or sets Language
Language code code
Name string Gets or sets Language
Language name name

1424 | P a g e
 MSN Weather

MSN Weather
MSN Weather gets you the very latest weather forecast, including
temperature, humidity, precipitation for your location.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
CurrentWeather (string Get current weather
Location, string units)
TodaysForecast (string Get forecast for today
Location, string units)
TomorrowsForecast (string Get the forecast for tomorrow
Location, string units)
GetMeasureUnits (string Get Measure Units
Location, string Measure,
string units)

Triggers:
Name Summary
OnCurrentWeatherChange When the current weather changes
(string Location, string
Measure, string When,
number Target, string units)
OnCurrentConditionsChange When the current conditions change
(string Location, string units)

1425 | P a g e
 MSN Weather

Objects:
Name Summary
CurrentWeather
GetMeasureUnitsResponseItem
WeatherForecast

Actions:
CurrentWeather
Summary: Get current weather
Description: Get the current weather for a location.

Syntax:
MSNWeather.CurrentWeather (string Location, string units)

Parameters:
Name Type Summary Required Related
Action
Location string True
(Location)
units string True
(Units)Values:
[Imperial,
Metric]

Returns:
Type:CurrentWeather

1426 | P a g e
 MSN Weather

TodaysForecast
Summary: Get forecast for today
Description: Get the forecast for the current day in the specified location.

Syntax:
MSNWeather.TodaysForecast (string Location, string units)

Parameters:
Name Type Summary Required Related
Action
Location string True
(Location)
units string True
(Units)Values:
[Imperial,
Metric]

Returns:
Type:WeatherForecast

TomorrowsForecast
Summary: Get the forecast for tomorrow
Description: Get the forecast for tomorrow in the specified location.

Syntax:
MSNWeather.TomorrowsForecast (string Location, string units)

Parameters:

1427 | P a g e
 MSN Weather

Name Type Summary Required Related

Action
Location string True
(Location)
units string True
(Units)Values:
[Imperial,
Metric]

Returns:
Type:WeatherForecast

GetMeasureUnits
Summary: Get Measure Units
Description: Get Measure Units

Syntax:
MSNWeather.GetMeasureUnits (string Location, string Measure,
string units)

Parameters:
Name Type Summary Required Related
Action
Location string True
(Location)
Measure string True
(Measure)Values:
[Temperature,
UV Index,

1428 | P a g e
 MSN Weather

Humidity, Wind
Speed]
units string True
(Units)Values:
[Imperial, Metric]

Returns:
Type:array of (GetMeasureUnitsResponseItem)

Triggers:
Trigger OnCurrentWeatherChange
Summary: When the current weather changes
Description: Triggers a new flow when the specified weather measure changes for a
location.

Syntax:
MSNWeather.OnCurrentWeatherChange (string Location, string
Measure, string When, number Target, string units)

Parameters:
Name Type Summary Required Related Action
Location string True
(Location)
Measure string True
(Measure)Values:
[Temperature, UV
Index, Humidity,
Wind Speed]
When string True

1429 | P a g e
 MSN Weather

(When the
measure...)Values:
[Is equal to, Goes
over, Goes below]
Target number(float) True
(Target)
units string True GetMeasureUnits
(Units)

Returns:
Type:CurrentWeather

Trigger OnCurrentConditionsChange
Summary: When the current conditions change
Description: Triggers a new flow when the conditions change for a location.

Syntax:
MSNWeather.OnCurrentConditionsChange (string Location, string
units)

Parameters:
Name Type Summary Required Related
Action
Location string True
(Location)
units string True
(Units)Values:
[Imperial,
Metric]

1430 | P a g e
 MSN Weather

Returns:
Type:CurrentWeather

1431 | P a g e
 MSN Weather

CurrentWeather
Summary:
Description:

Properties:
Name Type Summary
responses Responses

units Units

Responses
Summary:
Description:

Properties:
Name Type Summary
weather Weather

source Source

Weather
Summary:
Description:

Properties:
Name Type Summary
current Current

1432 | P a g e
 MSN Weather

Current
Summary:
Description:

Properties:
Name Type Summary
baro number(float) The atmospheric pressure.
Pressure
cap string A caption of weather
Conditions conditions such as rainy,
sunny, etc.
dewPt number(float) The temperature at which
Dewpoint dew forms.
feels number(float) The apparent
Apparent Temperature temperature, or feels-like
temperature.
rh number(float) The relative humidity
Humidity percentage.
wx string The METAR code of
METAR weather weather conditions.
conditions
sky string The METAR code of sky
METAR Sky Conditions conditions.
temp number(float) The current temperature.
Temperature
uv number(float) The numerical UV index.
UV Index

1433 | P a g e
 MSN Weather

uvDesc string A description of the

UV Index Description meaning of the UV index.
vis number(float) The visibility distance.
Visibility Distance
windDir integer(int32) The wind direction in
Wind Direction degrees clockwise from
north.
windSpd number(float) The wind speed.
Wind Speed
windGust number(float) The wind gust speed.
Wind Gust Speed
created string(date-time) The datetime at which
Last Updated provider created the
current condition.

Source
Summary:
Description:

Properties:
Name Type Summary
coordinates Coordinates

clickThrough string The URL to the full

Click-through Link weather details.
location string The location for which
Location provider created the
current condition.

1434 | P a g e
 MSN Weather

Coordinates
Summary:
Description:

Properties:
Name Type Summary
lat number(float) The latitude of the
Latitude location.
lon number(float) The longitude of the
Longitude location.

Units
Summary:
Description:

Properties:
Name Type Summary
system string Units used in data set
Unit System (metric or imperial).
pressure string Units used for pressure
Pressure Units measurements.
temperature string Units used for
Temperature Units temperature
measurements.
speed string Units used for speed
Speed Units measurements.
distance string Units used for distance
Distance Units measurements.

1435 | P a g e
 MSN Weather

1436 | P a g e
 MSN Weather

GetMeasureUnitsResponseItem
Summary:
Description:

Properties:
Name Type Summary
displayText string

units string

1437 | P a g e
 MSN Weather

WeatherForecast
Summary:
Description:

Properties:
Name Type Summary
responses Responses

units Units

Responses
Summary:
Description:

Properties:
Name Type Summary
daily Daily

almanac Almanac

source Source

Daily
Summary:
Description:

Properties:

1438 | P a g e
 MSN Weather

Name Type Summary

day Day
Day
night Night
Night
pvdrCap string The caption of weather
Conditions conditions such as rainy,
sunny, etc.
valid string(date-time) The datetime at which the
Date forecast is valid.
precip number(float) The chance of
Rain Chance precipitation (%).
windMax number(float) The peak wind speed for
Max Wind Speed the day.
windMaxDir integer(int32) The direction of the peak
Max Wind Direction wind for the day.
rhHi number(float) The high relative humidity
Humidity High point for the day.
rhLo number(float) The low relative humidity
Humidity Low point for the day.
tempHi number(float) The high temperature.
Temperature High
tempLo number(float) The low temperature.
Temperature Low
uv number(float) The numerical UV index.
UV Index
uvDesc string A description of the
UV Index Description meaning of the UV index.

1439 | P a g e
 MSN Weather

created string(date-time) The datetime at which the

Forecast Date daily forecast was dervied.

Day
Summary: Day
Description:

Properties:
Name Type Summary
cap string The caption of weather
Conditions conditions such as rainy,
sunny, etc.
precip number(float) The chance of
Rain Chance precipitation (%).
wx string The METAR code of
METAR Weather weather conditions.
Conditions
sky string The METAR code of sky
METAR Sky Conditions conditions.
windDir integer(int32) The wind direction in
Wind Direction degrees clockwise from
north.
windSpd number(float) The wind speed.
Wind Speed
summary string
Summary

Night
Summary: Night

1440 | P a g e
 MSN Weather

Description:

Properties:
Name Type Summary
cap string The caption of weather
Conditions conditions such as rainy,
sunny, etc.
precip number(float) The chance of
Rain Chance precipitation (%).
wx string The METAR code of
METAR Weather weather conditions.
Conditions
sky string The METAR code of sky
METAR Sky Conditions conditions.
windDir integer(int32) The wind direction in
Wind Direction degrees clockwise from
north.
windSpd number(float) The wind speed.
Wind Speed
summary string
Summary

Almanac
Summary:
Description:

Properties:
Name Type Summary

1441 | P a g e
 MSN Weather

sunrise string(date-time) Time of sunrise on the day

Sunrise Time of this forecast.
sunset string(date-time) Time of sunset on the day
Sunset Time of this forecast.
moonrise string(date-time) Time of moonrise on the
Moonrise Time day of this forecast.
moonset string(date-time) Time of moonset on the
Moonset Time day of this forecast.
moonPhase string The phase of the moon
Moon Phase the day of this forecast.
moonPhaseCode string The code representing the
Moon Phase Code phase of the moon.

Source
Summary:
Description:

Properties:
Name Type Summary
coordinates Coordinates

clickThrough string The URL back to the full

Click-through Link weather details.
location string The location for which
Location provider created the
forecast.

Coordinates
Summary:

1442 | P a g e
 MSN Weather

Description:

Properties:
Name Type Summary
lat number(float) The latitude of the
Latitude location.
lon number(float) The longitude of the
Longitude location.

Units
Summary:
Description:

Properties:
Name Type Summary
system string Units used in data set
Unit System (metric or imperial).
pressure string Units used for pressure
Pressure Units measurements.
temperature string Units used for
Temperature Units temperature
measurements.
speed string Units used for speed
Speed Units measurements.
distance string Units used for distance
Distance Units measurements.

1443 | P a g e
 Muhimbi PDF

Muhimbi PDF
Convert, Merge, Watermark, Secure and OCR files.

Status: Preview Tier: Standard Version: 9.9

Actions:
Name Summary
action_task (string task_id)
composite_watermark Add composite watermark
(composite_watermark_data
input_data)
convert (convert_data Convert document
input_data)
convert_html Convert HTML to PDF
(convert_html_data
input_data)
copy_metadata Copy metadata (SharePoint only)
(copy_metadata_data
input_data)
ellipse_watermark Add ellipse watermark
(ellipse_watermark_data
input_data)
image_watermark Add image watermark
(image_watermark_data
input_data)
line_watermark Add line watermark
(line_watermark_data
input_data)

1444 | P a g e
 Muhimbi PDF

merge_to_pdf Merge documents

(merge_to_pdf_data
input_data)
ocr_pdf (ocr_pdf_data Convert to OCRed PDF
input_data)
ocr_text (ocr_text_data Extract text using OCR
input_data)
ocr_text_task (string task_id)
pdf_watermark Add PDF watermark
(pdf_watermark_data
input_data)
qr_code_watermark Add QR Code watermark
(qr_code_watermark_data
input_data)
rectangle_watermark Add rectangle watermark
(rectangle_watermark_data
input_data)
rtf_watermark Add RTF watermark
(rtf_watermark_data
input_data)
secure_pdf (secure_pdf_data Secure PDF
input_data)
split_pdf (split_pdf_data Split PDF
input_data)
split_pdf_task (string task_id)
text_watermark Add text watermark
(text_watermark_data
input_data)

1445 | P a g e
 Muhimbi PDF

Triggers:
Name Summary

Objects:
Name Summary
composite_watermark_data
convert_data
convert_html_data
copy_metadata_data
ellipse_watermark_data
image_watermark_data
line_watermark_data
merge_to_pdf_data
ocr_operation_response
ocr_pdf_data
ocr_text_data
operation_response
operation_response_common
pdf_watermark_data
qr_code_watermark_data
rectangle_watermark_data
rtf_watermark_data
secure_pdf_data
sharepoint_file
split_operation_response
split_pdf_data
text_watermark_data

1446 | P a g e
 Muhimbi PDF

Actions:
action_task
Summary:
Description:

Syntax:
MuhimbiPDF.action_task (string task_id)

Parameters:
Name Type Summary Required Related
Action
task_id string True

Returns:
Type:operation_response
Description: Response data for all operations

composite_watermark
Summary: Add composite watermark
Description: Add a complex watermark to a PDF file.

Syntax:
MuhimbiPDF.composite_watermark (composite_watermark_data
input_data)

Parameters:

1447 | P a g e
 Muhimbi PDF

Name Type Summary Require Relate

d d
Action
input_dat composite_watermark_dat Parameters for True
a a CompositeWatermar
k operation

Returns:
Type:operation_response
Description: Response data for all operations

convert
Summary: Convert document
Description: Convert a file to PDF or other format.

Syntax:
MuhimbiPDF.convert (convert_data input_data)

Parameters:
Name Type Summary Required Related
Action
input_data convert_data Parameters for True
Convert
operation

Returns:
Type:operation_response
Description: Response data for all operations

1448 | P a g e
 Muhimbi PDF

convert_html
Summary: Convert HTML to PDF
Description: Convert URLs or HTML to PDF.

Syntax:
MuhimbiPDF.convert_html (convert_html_data input_data)

Parameters:
Name Type Summary Required Related
Action
input_data convert_html_data Parameters for True
ConvertHtml
operation

Returns:
Type:operation_response
Description: Response data for all operations

copy_metadata
Summary: Copy metadata (SharePoint only)
Description: Copy metadata and set content type.

Syntax:
MuhimbiPDF.copy_metadata (copy_metadata_data input_data)

Parameters:
Name Type Summary Required Related
Action

1449 | P a g e
 Muhimbi PDF

input_data copy_metadata_data Parameters for True

CopyMetadata
operation

Returns:
Type:operation_response_common
Description: Response data for all operations

ellipse_watermark
Summary: Add ellipse watermark
Description: Add an ellipse watermark to a PDF file.

Syntax:
MuhimbiPDF.ellipse_watermark (ellipse_watermark_data input_data)

Parameters:
Name Type Summary Required Related
Action
input_data ellipse_watermark_data Parameters for True
EllipseWatermark
operation

Returns:
Type:operation_response
Description: Response data for all operations

image_watermark
Summary: Add image watermark
Description: Add an image based watermark to a PDF file.

1450 | P a g e
 Muhimbi PDF

Syntax:
MuhimbiPDF.image_watermark (image_watermark_data input_data)

Parameters:
Name Type Summary Required Related
Action
input_data image_watermark_data Parameters for True
ImageWatermark
operation

Returns:
Type:operation_response
Description: Response data for all operations

line_watermark
Summary: Add line watermark
Description: Add a line watermark to a PDF file.

Syntax:
MuhimbiPDF.line_watermark (line_watermark_data input_data)

Parameters:
Name Type Summary Required Related
Action
input_data line_watermark_data Parameters for True
LineWatermark
operation

1451 | P a g e
 Muhimbi PDF

Returns:
Type:operation_response
Description: Response data for all operations

merge_to_pdf
Summary: Merge documents
Description: Merge multiple files into a single PDF.

Syntax:
MuhimbiPDF.merge_to_pdf (merge_to_pdf_data input_data)

Parameters:
Name Type Summary Required Related
Action
input_data merge_to_pdf_data Parameters for True
MergeToPdf
operation

Returns:
Type:operation_response
Description: Response data for all operations

ocr_pdf
Summary: Convert to OCRed PDF
Description: Convert a file to an OCRed PDF.

Syntax:
MuhimbiPDF.ocr_pdf (ocr_pdf_data input_data)

1452 | P a g e
 Muhimbi PDF

Parameters:
Name Type Summary Required Related
Action
input_data ocr_pdf_data Parameters for True
OCRText
operation

Returns:
Type:operation_response
Description: Response data for all operations

ocr_text
Summary: Extract text using OCR
Description: Extract text from a file using OCR.

Syntax:
MuhimbiPDF.ocr_text (ocr_text_data input_data)

Parameters:
Name Type Summary Required Related
Action
input_data ocr_text_data Parameters for True
OCRText
operation

Returns:
Type:ocr_operation_response
Description: Response data for OCRText operation

1453 | P a g e
 Muhimbi PDF

ocr_text_task
Summary:
Description:

Syntax:
MuhimbiPDF.ocr_text_task (string task_id)

Parameters:
Name Type Summary Required Related
Action
task_id string True

Returns:
Type:ocr_operation_response
Description: Response data for OCRText operation

pdf_watermark
Summary: Add PDF watermark
Description: Add a PDF based watermark to a PDF file.

Syntax:
MuhimbiPDF.pdf_watermark (pdf_watermark_data input_data)

Parameters:
Name Type Summary Required Related
Action

1454 | P a g e
 Muhimbi PDF

input_data pdf_watermark_data Parameters for True

PDFWatermark
operation

Returns:
Type:operation_response
Description: Response data for all operations

qr_code_watermark
Summary: Add QR Code watermark
Description: Add a QR Code watermark to a PDF file.

Syntax:
MuhimbiPDF.qr_code_watermark (qr_code_watermark_data input_data)

Parameters:
Name Type Summary Required Related
Action
input_data qr_code_watermark_data Parameters for True
QRCodeWatermark
operation

Returns:
Type:operation_response
Description: Response data for all operations

rectangle_watermark
Summary: Add rectangle watermark
Description: Add a rectangle watermark to a PDF file.

1455 | P a g e
 Muhimbi PDF

Syntax:
MuhimbiPDF.rectangle_watermark (rectangle_watermark_data
input_data)

Parameters:
Name Type Summary Require Relate
d d
Action
input_dat rectangle_watermark_dat Parameters for True
a a RectangleWatermar
k operation

Returns:
Type:operation_response
Description: Response data for all operations

rtf_watermark
Summary: Add RTF watermark
Description: Add a rich-text watermark to a PDF file.

Syntax:
MuhimbiPDF.rtf_watermark (rtf_watermark_data input_data)

Parameters:
Name Type Summary Required Related
Action

1456 | P a g e
 Muhimbi PDF

input_data rtf_watermark_data Parameters for True

RTFWatermark
operation

Returns:
Type:operation_response
Description: Response data for all operations

secure_pdf
Summary: Secure PDF
Description: Apply security and encryption settings.

Syntax:
MuhimbiPDF.secure_pdf (secure_pdf_data input_data)

Parameters:
Name Type Summary Required Related
Action
input_data secure_pdf_data Parameters for True
SecurePdf
operation

Returns:
Type:operation_response
Description: Response data for all operations

split_pdf
Summary: Split PDF
Description: Split a PDF file into multiple PDFs.

1457 | P a g e
 Muhimbi PDF

Syntax:
MuhimbiPDF.split_pdf (split_pdf_data input_data)

Parameters:
Name Type Summary Required Related
Action
input_data split_pdf_data Parameters for True
SplitPdf
operation

Returns:
Type:split_operation_response
Description: Response data for split operation

split_pdf_task
Summary:
Description:

Syntax:
MuhimbiPDF.split_pdf_task (string task_id)

Parameters:
Name Type Summary Required Related
Action
task_id string True

Returns:

1458 | P a g e
 Muhimbi PDF

Type:split_operation_response
Description: Response data for split operation

text_watermark
Summary: Add text watermark
Description: Add a plain-text watermark to a PDF file.

Syntax:
MuhimbiPDF.text_watermark (text_watermark_data input_data)

Parameters:
Name Type Summary Required Related
Action
input_data text_watermark_data Parameters for True
TextWatermark
operation

Returns:
Type:operation_response
Description: Response data for all operations

1459 | P a g e
 Muhimbi PDF

composite_watermark_data
Summary:
Description: Parameters for CompositeWatermark operation

Properties:
Name Type Summary
source_file_name string Optional file name (for
Source file name logging purposes)
use_async_pattern boolean Use async behaviour for
Use async pattern API request
source_file_content string(byte) Content of the file to
Source file content watermark
sharepoint_file sharepoint_file SharePoint file
information for operation
watermark_data string Watermark data in
Watermark data Muhimbi XML format
fail_on_error boolean Fail on error
Fail on error

1460 | P a g e
 Muhimbi PDF

convert_data
Summary:
Description: Parameters for Convert operation

Properties:
Name Type Summary
use_async_pattern boolean Use async behaviour for
Use async pattern API request
source_file_name string Name of the source file
Source file name including extension
source_file_content string(byte) Content of the file to
Source file content convert
sharepoint_file sharepoint_file SharePoint file
information for operation
output_format string(enum) Output format Values:
Output format [PDF, XPS, DOCX, DOC,
ODT, RTF, TXT, MHT,
HTML, XML, XLS, XLSX,
CSV, ODS, PPT, PPTX,
ODP, PPS, PPSX, TIFF,
PNG, GIF, JPG, BMP, PS,
PCL, EPS]
copy_metadata boolean Copy metadata (Only for
Copy metadata SharePoint operations)
override_settings string Optional settings using
Override settings Muhimbi's XML syntax
template_file_content string(byte) Optional template file
Template file content content (e.g. infopath
XSN file)

1461 | P a g e
 Muhimbi PDF

fail_on_error boolean Fail on error

Fail on error

1462 | P a g e
 Muhimbi PDF

convert_html_data
Summary:
Description: Parameters for ConvertHtml operation

Properties:
Name Type Summary
use_async_pattern boolean Use async behaviour for
Use async pattern API request
source_url_or_html string HTML fragment or URL to
Source URL or HTML convert
page_orientation string(enum) Page orientation Values:
Page orientation [Portrait, Landscape]
username string User name
User name
password string(password) Password
Password
authentication_type string(enum) Authentication type
Authentication type Values: [Basic]
fail_on_error boolean Fail on error
Fail on error

1463 | P a g e
 Muhimbi PDF

copy_metadata_data
Summary:
Description: Parameters for CopyMetadata operation

Properties:
Name Type Summary
site_url string SharePoint site url (example:
Site url http://contoso.sharepoint.com/sites/mysite)
source_file_url string Path to the source file
Source file url
destination_file_url string Path to the destination file
Destination
file path
username string User name to log in to the SharePoint site
User name
password string Password to log in to the SharePoint site
Password
copy_fields string Optional comma separated list of fields
Fields to copy
content_type string Optional content type for the destination file
Destination
content type
fail_on_error boolean Fail on error
Fail on error

1464 | P a g e
 Muhimbi PDF

ellipse_watermark_data
Summary:
Description: Parameters for EllipseWatermark operation

Properties:
Name Type Summary
source_file_name string Optional file name (for
Source file name logging purposes)
use_async_pattern boolean Use async behaviour for
Use async pattern API request
source_file_content string(byte) Content of the file to
Source file content watermark
position string(enum) Watermark position on
Position the page Values: [Top
Left, Top Center, Top
Right, Middle Left, Middle
Center, Middle Right,
Bottom Left, Bottom
Center, Bottom Right,
Absolute, Random]
sharepoint_file sharepoint_file SharePoint file
information for operation
width string Width of the watermark
Width (in Pts, 1/72 of an inch)
height string Height of the watermark
Height (in Pts, 1/72 of an inch)
x string X Coordinate of the
watermark (in Pts, 1/72
of an inch)

1465 | P a g e
 Muhimbi PDF

X Coordinate (When
'Position' is set to
'Absolute')
y string Y Coordinate of the
Y Coordinate (When watermark (in Pts, 1/72
'Position' is set to of an inch)
'Absolute')
layer string(enum) Watermark layer Values:
Layer [Background,
Foreground]
rotation string Angle of rotation
Rotation
opacity string Opacity in % (100 is fully
Opacity visible and 1 is barely
visible)
fill_color string Color in #RRGGBB
Fill color notation
line_color string Color in #RRGGBB
Line color notation
line_width string Width of the line (in Pts,
Line width 1/72 of an inch)
start_page integer(int32) Number of the first page
Watermark start page the watermark applies to
end_page integer(int32) Number of the last page
Watermark end page the watermark applies to
page_interval integer(int32) Which pages to display
Watermark page interval the watermark on
(1=every page, 2=every
other, etc)

1466 | P a g e
 Muhimbi PDF

page_orientation string(enum) Orientation of pages the

Watermark page watermark applies to.
orientation Values: [Portrait,
Landscape, Both]
fail_on_error boolean Fail on error
Fail on error

1467 | P a g e
 Muhimbi PDF

image_watermark_data
Summary:
Description: Parameters for ImageWatermark operation

Properties:
Name Type Summary
source_file_name string Optional file name (for
Source file name logging purposes)
use_async_pattern boolean Use async behaviour for
Use async pattern API request
source_file_content string(byte) Content of the file to
Source file content watermark
image_file string(byte) Image content or URL
Image
sharepoint_file sharepoint_file SharePoint file
information for operation
position string(enum) Watermark position on
Position the page Values: [Top
Left, Top Center, Top
Right, Middle Left, Middle
Center, Middle Right,
Bottom Left, Bottom
Center, Bottom Right,
Absolute, Random]
width string Width of the watermark
Width (in Pts, 1/72 of an inch)
height string Height of the watermark
Height (in Pts, 1/72 of an inch)

1468 | P a g e
 Muhimbi PDF

x string X Coordinate of the

X Coordinate (When watermark (in Pts, 1/72
'Position' is set to of an inch)
'Absolute')
y string Y Coordinate of the
Y Coordinate (When watermark (in Pts, 1/72
'Position' is set to of an inch)
'Absolute')
layer string(enum) Watermark layer Values:
Layer [Background,
Foreground]
rotation string Angle of rotation
Rotation
opacity string Opacity in % (100 is fully
Opacity visible and 1 is barely
visible)
fill_color string Color in #RRGGBB
Watermark background notation
color
line_color string Color in #RRGGBB
Watermark outline color notation
line_width string Width of the watermark
Watermark outline width outline (in Pts, 1/72 of an
inch)
start_page integer(int32) Number of the first page
Watermark start page the watermark applies to
end_page integer(int32) Number of the last page
Watermark end page the watermark applies to

1469 | P a g e
 Muhimbi PDF

page_interval integer(int32) Which pages to display

Watermark page interval the watermark on
(1=every page, 2=every
other, etc)
page_orientation string(enum) Orientation of pages the
Watermark page watermark applies to.
orientation Values: [Portrait,
Landscape, Both]
fail_on_error boolean Fail on error
Fail on error

1470 | P a g e
 Muhimbi PDF

line_watermark_data
Summary:
Description: Parameters for LineWatermark operation

Properties:
Name Type Summary
source_file_name string Optional file name (for
Source file name logging purposes)
use_async_pattern boolean Use async behaviour for
Use async pattern API request
source_file_content string(byte) Content of the file to
Source file content watermark
position string(enum) Watermark position on
Position the page Values: [Top
Left, Top Center, Top
Right, Middle Left, Middle
Center, Middle Right,
Bottom Left, Bottom
Center, Bottom Right,
Absolute, Random]
sharepoint_file sharepoint_file SharePoint file
information for operation
x string Start X Coordinate of the
X Coordinate (start) line (in Pts, 1/72 of an
inch)
y string Start Y Coordinate of the
Y Coordinate (start) line (in Pts, 1/72 of an
inch)

1471 | P a g e
 Muhimbi PDF

end_x string End X Coordinate of the

X Coordinate (end) line (in Pts, 1/72 of an
inch)
end_y string End Y Coordinate of the
Y Coordinate (end) line (in Pts, 1/72 of an
inch)
layer string(enum) Watermark layer Values:
Layer [Background,
Foreground]
rotation string Angle of rotation
Rotation
opacity string Opacity in % (100 is fully
Opacity visible and 1 is barely
visible)
line_color string Color in #RRGGBB
Line color notation
line_width string Width of the line (in Pts,
Line width 1/72 of an inch)
start_page integer(int32) Number of the first page
Watermark start page the watermark applies to
end_page integer(int32) Number of the last page
Watermark end page the watermark applies to
page_interval integer(int32) Which pages to display
Watermark page interval the watermark on
(1=every page, 2=every
other, etc)
page_orientation string(enum) Orientation of pages the
Watermark page watermark applies to.
orientation

1472 | P a g e
 Muhimbi PDF

Values: [Portrait,
Landscape, Both]
fail_on_error boolean Fail on error
Fail on error

1473 | P a g e
 Muhimbi PDF

merge_to_pdf_data
Summary:
Description: Parameters for MergeToPdf operation

Properties:
Name Type Summary
use_async_pattern boolean Use async behaviour for
Use async pattern API request
source_file_name_1 string Name of the source file
Source file name - 1 including extension
source_file_content_1 string(byte) Content of the file to
Source file content - 1 merge
source_file_name_2 string Name of the source file
Source file name - 2 including extension
source_file_content_2 string(byte) Content of the file to
Source file content - 2 merge
source_file_name_3 string Name of the source file
Source file name - 3 including extension
source_file_content_3 string(byte) Content of the file to
Source file content - 3 merge
source_file_name_4 string Name of the source file
Source file name - 4 including extension
source_file_content_4 string(byte) Content of the file to
Source file content - 4 merge
source_file_name_5 string Name of the source file
Source file name - 5 including extension
source_file_content_5 string(byte) Content of the file to
Source file content - 5 merge

1474 | P a g e
 Muhimbi PDF

sharepoint_file sharepoint_file SharePoint file

information for
operation
sharepoint_field_name string Bookmark field name
Field name (For SharePoint only)
document_start_page string(enum) Document start page
Each document Values: [Starts on the
default page, Starts on
the next page, Starts on
the next odd page, Starts
on the next even page]
fail_on_error boolean Fail on error
Fail on error

1475 | P a g e
 Muhimbi PDF

ocr_operation_response
Summary:
Description: Response data for OCRText operation

Properties:
Name Type Summary
out_text string Extracted OCRed text in plain
Out text text.
base_file_name string Name of the input file
Base file name without the extension.
result_code string(enum) Operation result code.
Result code Values: [Success,
ProcessingError,
SubscriptionNotFound,
SubscriptionExpired,
ActivationPending,
TrialExpired,
OperationSizeExceeded,
OperationsExceeded,
InputFileTypeNotSupported,
OutputFileTypeNotSupported,
OperationNotSupported,
Accepted, AccessDenied]
result_details string Operation result details.
Result details

1476 | P a g e
 Muhimbi PDF

ocr_pdf_data
Summary:
Description: Parameters for OCRText operation

Properties:
Name Type Summary
use_async_pattern boolean Use async behaviour for
Use async pattern API request
source_file_name string Name of the source file
Source file name including extension
source_file_content string(byte) Content of the file to OCR
Source file content
sharepoint_file sharepoint_file SharePoint file
information for operation
copy_metadata boolean Copy metadata (For
MetaData SharePoint only)
language string(enum) Language Values:
Language [English, Arabic, Danish,
German, Dutch, Finnish,
French, Hebrew,
Hungarian, Italian,
Norwegian, Portuguese,
Spanish, Swedish]
performance string(enum) Performance Values:
Performance [Slow but accurate, Faster
and less accurate, Fastest
and least accurate]

1477 | P a g e
 Muhimbi PDF

characters_option string(enum) Characters option

Blacklist / whitelist Values: [None, Whitelist,
Blacklist]
characters string Characters to blacklist or
Characters whitelist
paginate boolean Paginate
Use pagination
regions string Limit the area to OCR to
Regions one or more specific
areas
fail_on_error boolean Fail on error
Fail on error

1478 | P a g e
 Muhimbi PDF

ocr_text_data
Summary:
Description: Parameters for OCRText operation

Properties:
Name Type Summary
use_async_pattern boolean Use async behaviour for
Use async pattern API request
source_file_name string Name of the source file
Source file name including extension
source_file_content string(byte) Content of the file to OCR
Source file content
sharepoint_file sharepoint_file SharePoint file
information for operation
language string(enum) Languate Values:
Language [English, Arabic, Danish,
German, Dutch, Finnish,
French, Hebrew,
Hungarian, Italian,
Norwegian, Portuguese,
Spanish, Swedish]
x string X Coordinate (in Pts, 1/72
X Coordinate of an inch)
y string Y Coordinate (in Pts, 1/72
Y Coordinate of an inch)
width string Width of the OCR area (in
Width Pts, 1/72 of an inch)
height string Height of the OCR area (in
Height Pts, 1/72 of an inch)

1479 | P a g e
 Muhimbi PDF

page_number string Page number (leave blank

Page number to OCR all pages)
performance string(enum) Performance () Values:
Performance [Slow but accurate, Faster
and less accurate, Fastest
and least accurate]
characters_option string(enum) Characters option
Blacklist / whitelist Values: [None, Whitelist,
Blacklist]
characters string Characters to blacklist or
Characters whitelist
paginate boolean Paginate
Use pagination
fail_on_error boolean Fail on error
Fail on error

1480 | P a g e
 Muhimbi PDF

operation_response
Summary:
Description: Response data for all operations

Properties:
Name Type Summary
processed_file_content string(byte) File generated by the
Processed file content Muhimbi converter.
base_file_name string Name of the input file
Base file name without the extension.
result_code string(enum) Operation result code.
Result code Values: [Success,
ProcessingError,
SubscriptionNotFound,
SubscriptionExpired,
ActivationPending,
TrialExpired,
OperationSizeExceeded,
OperationsExceeded,
InputFileTypeNotSupported,
OutputFileTypeNotSupported,
OperationNotSupported,
Accepted, AccessDenied]
result_details string Operation result details.
Result details

1481 | P a g e
 Muhimbi PDF

operation_response_common
Summary:
Description: Response data for all operations

Properties:
Name Type Summary
base_file_name string Name of the input file
Base file name without the extension.
result_code string(enum) Operation result code.
Result code Values: [Success,
ProcessingError,
SubscriptionNotFound,
SubscriptionExpired,
ActivationPending,
TrialExpired,
OperationSizeExceeded,
OperationsExceeded,
InputFileTypeNotSupported,
OutputFileTypeNotSupported,
OperationNotSupported,
Accepted, AccessDenied]
result_details string Operation result details.
Result details

1482 | P a g e
 Muhimbi PDF

pdf_watermark_data
Summary:
Description: Parameters for PDFWatermark operation

Properties:
Name Type Summary
source_file_name string Optional file name (for
Source file name logging purposes)
use_async_pattern boolean Use async behaviour for
Use async pattern API request
source_file_content string(byte) Content of the file to
Source file content watermark
pdf_file string(byte) PDF watermark content
PDF Watermark or URL
sharepoint_file sharepoint_file SharePoint file
information for operation
position string(enum) Watermark position on
Position the page Values: [Top
Left, Top Center, Top
Right, Middle Left, Middle
Center, Middle Right,
Bottom Left, Bottom
Center, Bottom Right,
Absolute, Random]
width string Width of the watermark
Width (in Pts, 1/72 of an inch)
height string Height of the watermark
Height (in Pts, 1/72 of an inch)

1483 | P a g e
 Muhimbi PDF

x string X Coordinate of the

X Coordinate (When watermark (in Pts, 1/72
'Position' is set to of an inch)
'Absolute')
y string Y Coordinate of the
Y Coordinate (When watermark (in Pts, 1/72
'Position' is set to of an inch)
'Absolute')
layer string(enum) Watermark layer Values:
Layer [Background,
Foreground]
rotation string Angle of rotation
Rotation
opacity string Opacity in % (100 is fully
Opacity visible and 1 is barely
visible)
start_page integer(int32) Number of the first page
Watermark start page the watermark applies to
end_page integer(int32) Number of the last page
Watermark end page the watermark applies to
page_interval integer(int32) Which pages to display
Watermark page interval the watermark on
(1=every page, 2=every
other, etc)
page_orientation string(enum) Orientation of pages the
Watermark page watermark applies to.
orientation Values: [Portrait,
Landscape, Both]
fail_on_error boolean Fail on error

1484 | P a g e
 Muhimbi PDF

Fail on error

1485 | P a g e
 Muhimbi PDF

qr_code_watermark_data
Summary:
Description: Parameters for QRCodeWatermark operation

Properties:
Name Type Summary
source_file_name string Optional file name (for
Source file name logging purposes)
use_async_pattern boolean Use async behaviour for
Use async pattern API request
source_file_content string(byte) Content of the file to
Source file content watermark
content string Data to embed in the QR
Content Code
sharepoint_file sharepoint_file SharePoint file
information for operation
version string(enum) Version Values: [Auto,
Version Version 1, Version 2,
Version 3, Version 4,
Version 5, Version 6,
Version 7, Version 8,
Version 9, Version 10,
Version 11, Version 12,
Version 13, Version 14,
Version 15, Version 16,
Version 17, Version 18,
Version 19, Version 20,
Version 21, Version 22,
Version 23, Version 24,

1486 | P a g e
 Muhimbi PDF

Version 25, Version 26,

Version 27, Version 28,
Version 29, Version 30,
Version 31, Version 32,
Version 33, Version 34,
Version 35, Version 36,
Version 37, Version 38,
Version 39, Version 40]
input_mode string(enum) Input mode Values:
Input mode [Binary, Alphanumeric,
Numeric]
error_correction_level string(enum) Error correction level
Error correction level Values: [Low, Medium,
High, Quartile]
position string(enum) Watermark position on
Position the page Values: [Top
Left, Top Center, Top
Right, Middle Left, Middle
Center, Middle Right,
Bottom Left, Bottom
Center, Bottom Right,
Absolute, Random]
width string Width of the watermark
Width (in Pts, 1/72 of an inch)
height string Height of the watermark
Height (in Pts, 1/72 of an inch)
x string X Coordinate of the
watermark (in Pts, 1/72
of an inch)

1487 | P a g e
 Muhimbi PDF

X Coordinate (When
'Position' is set to
'Absolute')
y string Y Coordinate of the
Y Coordinate (When watermark (in Pts, 1/72
'Position' is set to of an inch)
'Absolute')
layer string(enum) Watermark layer Values:
Layer [Background,
Foreground]
rotation string Angle of rotation
Rotation
opacity string Opacity in % (100 is fully
Opacity visible and 1 is barely
visible)
fill_color string Color in #RRGGBB
Watermark background notation
color
line_color string Color in #RRGGBB
Watermark foreground notation
color
start_page integer(int32) Number of the first page
Watermark start page the watermark applies to
end_page integer(int32) Number of the last page
Watermark end page the watermark applies to
page_interval integer(int32) Which pages to display
Watermark page interval the watermark on
(1=every page, 2=every
other, etc)

1488 | P a g e
 Muhimbi PDF

page_orientation string(enum) Orientation of pages the

Watermark page watermark applies to.
orientation Values: [Portrait,
Landscape, Both]
fail_on_error boolean Fail on error
Fail on error

1489 | P a g e
 Muhimbi PDF

rectangle_watermark_data
Summary:
Description: Parameters for RectangleWatermark operation

Properties:
Name Type Summary
source_file_name string Optional file name (for
Source file name logging purposes)
use_async_pattern boolean Use async behaviour for
Use async pattern API request
source_file_content string(byte) Content of the file to
Source file content watermark
position string(enum) Watermark position on
Position the page Values: [Top
Left, Top Center, Top
Right, Middle Left, Middle
Center, Middle Right,
Bottom Left, Bottom
Center, Bottom Right,
Absolute, Random]
sharepoint_file sharepoint_file SharePoint file
information for operation
width string Width of the watermark
Width (in Pts, 1/72 of an inch)
height string Height of the watermark
Height (in Pts, 1/72 of an inch)
x string X Coordinate of the
watermark (in Pts, 1/72
of an inch)

1490 | P a g e
 Muhimbi PDF

X Coordinate (When
'Position' is set to
'Absolute')
y string Y Coordinate of the
Y Coordinate (When watermark (in Pts, 1/72
'Position' is set to of an inch)
'Absolute')
layer string(enum) Watermark layer Values:
Layer [Background,
Foreground]
rotation string Angle of rotation
Rotation
opacity string Opacity in % (100 is fully
Opacity visible and 1 is barely
visible)
fill_color string Color in #RRGGBB
Watermark background notation
color
line_color string Color in #RRGGBB
Watermark outline color notation
line_width string Width of the watermark
Watermark outline width outline (in Pts, 1/72 of an
inch)
start_page integer(int32) Number of the first page
Watermark start page the watermark applies to
end_page integer(int32) Number of the last page
Watermark end page the watermark applies to
page_interval integer(int32) Which pages to display
Watermark page interval the watermark on

1491 | P a g e
 Muhimbi PDF

(1=every page, 2=every

other, etc)
page_orientation string(enum) Orientation of pages the
Watermark page watermark applies to.
orientation Values: [Portrait,
Landscape, Both]
fail_on_error boolean Fail on error
Fail on error

1492 | P a g e
 Muhimbi PDF

rtf_watermark_data
Summary:
Description: Parameters for RTFWatermark operation

Properties:
Name Type Summary
source_file_name string Optional file name (for
Source file name logging purposes)
use_async_pattern boolean Use async behaviour for
Use async pattern API request
source_file_content string(byte) Content of the file to
Source file content watermark
rtf_data string Watermark text in RTF
Watermark content format
sharepoint_file sharepoint_file SharePoint file
information for operation
position string(enum) Watermark position on
Position the page Values: [Top
Left, Top Center, Top
Right, Middle Left, Middle
Center, Middle Right,
Bottom Left, Bottom
Center, Bottom Right,
Absolute, Random]
width string Width of the watermark
Width (in Pts, 1/72 of an inch)
height string Height of the watermark
Height (in Pts, 1/72 of an inch)

1493 | P a g e
 Muhimbi PDF

x string X Coordinate of the

X Coordinate (When watermark (in Pts, 1/72
'Position' is set to of an inch)
'Absolute')
y string Y Coordinate of the
Y Coordinate (When watermark (in Pts, 1/72
'Position' is set to of an inch)
'Absolute')
layer string(enum) Watermark layer Values:
Layer [Background,
Foreground]
rotation string Angle of rotation
Rotation
opacity string Opacity in % (100 is fully
Opacity visible and 1 is barely
visible)
fill_color string Color in #RRGGBB
Watermark background notation
color
line_color string Color in #RRGGBB
Watermark outline color notation
line_width string Width of the watermark
Watermark outline width outline (in Pts, 1/72 of an
inch)
start_page integer(int32) Number of the first page
Watermark start page the watermark applies to
end_page integer(int32) Number of the last page
Watermark end page the watermark applies to

1494 | P a g e
 Muhimbi PDF

page_interval integer(int32) Which pages to display

Watermark page interval the watermark on
(1=every page, 2=every
other, etc)
page_orientation string(enum) Orientation of pages the
Watermark page watermark applies to.
orientation Values: [Portrait,
Landscape, Both]
fail_on_error boolean Fail on error
Fail on error

1495 | P a g e
 Muhimbi PDF

secure_pdf_data
Summary:
Description: Parameters for SecurePdf operation

Properties:
Name Type Summary
use_async boolean Use async behaviour for API request
_pattern Use
async
pattern
source_file string Optional file name (for logging purposes)
_name Source
file
name
source_file string(by Content of the file to secure
_content te)
Source
file
content
sharepoint sharepoi SharePoint file information for operation
_file nt_file

open_pass string(pa Password required to open the PDF

word ssword)
Open
passwor
d
owner_pas string(pa Password for PDF restrictions defined below
sword ssword)

1496 | P a g e
 Muhimbi PDF

Owner
passwor
d
security_o string Print|HighResolutionPrint|ContentCopy|Annotations|Form
ptions PDF Fields|ContentAccessibility|DocumentAssembly
restrictio
ns
fail_on_err boolean Fail on error
or Fail on
error

1497 | P a g e
 Muhimbi PDF

sharepoint_file
Summary:
Description: SharePoint file information for operation

Properties:
Name Type Summary
site_url string SharePoint site url (example:
Site url http://contoso.sharepoint.com/sites/mysite
)
source_file_url string Path to the source file
Source file path
destination_file_ur string Path to the destination file
l Destination file
path
username string User name to log in to the SharePoint site
User name
password string(password Password to log in to the SharePoint site’
)
Password

1498 | P a g e
 Muhimbi PDF

split_operation_response
Summary:
Description: Response data for split operation

Properties:
Name Type Summary
processed_file_contents array of (string(byte)) Files generated by the
Processed file content Muhimbi converter.
base_file_name string Name of the input file
Base file name without the extension.
result_code string(enum) Operation result code.
Result code Values: [Success,
ProcessingError,
SubscriptionNotFound,
SubscriptionExpired,
ActivationPending,
TrialExpired,
OperationSizeExceeded,
OperationsExceeded,
InputFileTypeNotSupported,
OutputFileTypeNotSupported,
OperationNotSupported,
Accepted, AccessDenied]
result_details string Operation result details.
Result details

1499 | P a g e
 Muhimbi PDF

split_pdf_data
Summary:
Description: Parameters for SplitPdf operation

Properties:
Name Type Summary
use_async_pattern boolean Use async behaviour for
Use async pattern API request
source_file_name string Name of the source file
Source file name including extension
source_file_content string(byte) Content of the file to
Source file content convert
sharepoint_file sharepoint_file SharePoint file information
for operation
file_name_template string File name template for
File name template splited files (For
SharePoint only)
file_split_type string(enum) Split by option Values:
File split type [ByNumberOfPages,
ByBookmarkLevel]
split_parameter integer(int32) Split parameters
Split parameter
fail_on_error boolean Fail on error
Fail on error

1500 | P a g e
 Muhimbi PDF

text_watermark_data
Summary:
Description: Parameters for TextWatermark operation

Properties:
Name Type Summary
source_file_name string Optional file name (for logging
Source file name purposes)
use_async_pattern boolean Use async behaviour for API
Use async pattern request
source_file_content string(byte) Content of the file to
Source file content watermark
content string Watermark text
Watermark content
sharepoint_file sharepoint_file SharePoint file information for
operation
font_family_name string Name of the font, e.g. Arial,
Font family name Times New Roman, Calibri
font_size string Size of the font in Pt
Font size
fill_color string Color in #RRGGBB notation
Font color
alignment string(enum) Text alignment Values: [Top
Text alignment Left, Top Center, Top Right,
Top Justfiy, Middle Left,
Middle Center, Middle Right,
Middle Justfiy, Bottom Left,
Bottom Center, Bottom Right,
Bottom Justfiy]

1501 | P a g e
 Muhimbi PDF

word_wrap string(enum) Spcifies if wordwrap text

Word wrap Values: [WordOnly, Character,
None, Word]
position string(enum) Watermark position on the
Position page Values: [Top Left, Top
Center, Top Right, Middle Left,
Middle Center, Middle Right,
Bottom Left, Bottom Center,
Bottom Right, Absolute,
Random]
width string Width of the watermark (in
Width Pts, 1/72 of an inch)
height string Height of the watermark (in
Height Pts, 1/72 of an inch)
x string X Coordinate of the watermark
X Coordinate (When (in Pts, 1/72 of an inch)
'Position' is set to
'Absolute')
y string Y Coordinate of the watermark
Y Coordinate (When (in Pts, 1/72 of an inch)
'Position' is set to
'Absolute')
layer string(enum) Watermark layer Values:
Layer [Background, Foreground]
rotation string Angle of rotation
Rotation
opacity string Opacity in % (100 is fully
Opacity visible and 1 is barely visible)

1502 | P a g e
 Muhimbi PDF

font_style string One or more styles, e.g.

Font style bold|italic|underline|strikeout
line_color string Color in #RRGGBB notation
Font outline color
line_width string Width of the font outline (in
Font outline width Pts, 1/72 of an inch)
start_page integer(int32) Number of the first page the
Watermark start page watermark applies to
end_page integer(int32) Number of the last page the
Watermark end page watermark applies to
page_interval integer(int32) Which pages to display the
Watermark page watermark on (1=every page,
interval 2=every other, etc)
page_orientation string(enum) Orientation of pages the
Watermark page watermark applies to. Values:
orientation [Portrait, Landscape, Both]
fail_on_error boolean Fail on error
Fail on error

1503 | P a g e
 Nexmo

Nexmo
Nexmo, the Vonage API Platform, enables you to add communications within
the context of your applications, including SMS, Voice and Chat.

Status: Preview Tier: Premium Version: 2.0

Actions:
Name Summary
SendSms (string from, string Send an SMS
to, string text,
[advanced][Optional]string
type,
[advanced][Optional]number
status-report-req,
[advanced][Optional]string
client-ref,
[advanced][Optional]string
vcard,
[advanced][Optional]string
vcal,
[advanced][Optional]number
ttl, [advanced][Optional]string
callback,
[advanced][Optional]number
message-class,
[advanced][Optional]string
udh,
[advanced][Optional]string

1504 | P a g e
 Nexmo

protocol-id,
[advanced][Optional]string
body,
[advanced][Optional]string
title,
[advanced][Optional]string
url,
[advanced][Optional]string
validity)
ListOwnedNumbers List owned numbers
([Optional]string Search
Pattern,
[advanced][Optional]number
index,
[advanced][Optional]number
size,
[advanced][Optional]number
pattern)
ListInboundNumbers (string List inbound numbers
country, [Optional]string
Search Pattern,
[advanced][Optional]number
pattern,
[advanced][Optional]string
features,
[advanced][Optional]number
size,
[advanced][Optional]number
index)

1505 | P a g e
 Nexmo

SendTts (string to, Send a speech file

[advanced][Optional]string
from, string text,
[advanced][Optional]string lg,
[advanced][Optional]string
voice,
[advanced][Optional]number
repeat,
[advanced][Optional]string
machine_detection,
[advanced][Optional]number
machine_timeout,
[advanced][Optional]string
callback,
[advanced][Optional]string
callback_method)
ListApplications List applications
([advanced][Optional]number
page_size,
[advanced][Optional]number
page_index)
CreateApplication (string Create new application
name, string type,
[advanced]string answer_url,
string event_url,
[advanced][Optional]string
answer_method,
[advanced][Optional]string
event_method)

1506 | P a g e
 Nexmo

GetApplication (string Get application by Id

application_id)
UpdateApplication (string Update an application
application_id, string name,
string type, [advanced]string
answer_url, string event_url,
[advanced][Optional]string
answer_method,
[advanced][Optional]string
event_method)
DeleteApplication (string Delete an application
application_id)

Triggers:
Name Summary

Objects:
Name Summary
applicationResponse
common
ListApplicationsResponse
ListNumbersResponse
smsResponse
ttsResponse

Actions:
SendSms
Summary: Send an SMS

1507 | P a g e
 Nexmo

Description: This operation is used to send an SMS.

Syntax:
Nexmo.SendSms (string from, string to, string text,
[advanced][Optional]string type, [advanced][Optional]number
status-report-req, [advanced][Optional]string client-ref,
[advanced][Optional]string vcard, [advanced][Optional]string
vcal, [advanced][Optional]number ttl, [advanced][Optional]string
callback, [advanced][Optional]number message-class,
[advanced][Optional]string udh, [advanced][Optional]string
protocol-id, [advanced][Optional]string body,
[advanced][Optional]string title, [advanced][Optional]string
url, [advanced][Optional]string validity)

Parameters:
Name Type Summary Required Related
Action
from string An alphanumeric True
(Sender Id) string.
to string International True
(To Phone format E.164.
Number)
text string SMS body. True
(Text)
type string Defaults to text. False
(Type)Values:
[text, binary,
wappush,
unicode,
vcal, vcard]

1508 | P a g e
 Nexmo

status-report-req number Set to 1 to False

(Delivery enable.
Receipts)
client-ref string For internal False
(Client reporting.
Reference)
vcard string vCard format. False
(Business
Card)
vcal string vCal format. False
(Calendar
Event)
ttl number In milliseconds. False
(Lifespan of
SMS)
callback string(url) Delivery receipt False
(Callback endpoint.
URL)
message-class number Pick a class. False
(Message
Class)Values:
[, , , ]
udh string Hex encoded False
(User Data UDH.
Header)
protocol-id string Protocol id. False
(Higher Level
Protocol)

1509 | P a g e
 Nexmo

body string Hex encoded False

(Body (If type binary data.
is binary.))
title string False
(Title (If type
is wappush.))
url string(url) Website Url. False
(Url (If type is
wappush.))
validity string In milliseconds. False
(Availability
(If type is
wappush.))

Returns:
Type:smsResponse

ListOwnedNumbers
Summary: List owned numbers
Description: This operation retrieves all numbers associated with your account.

Syntax:
Nexmo.ListOwnedNumbers ([Optional]string Search Pattern,
[advanced][Optional]number index, [advanced][Optional]number
size, [advanced][Optional]number pattern)

Parameters:
Name Type Summary Required Related
Action

1510 | P a g e
 Nexmo

Search Pattern string Pick a pattern. False

Values: [1,
2, 3]
index number Index in the False
(Page response.
Index)
size number Default 10 Max False
(Result 100.
Count)
pattern number Number pattern False
(Pattern) to search for.

Returns:
Type:ListNumbersResponse

ListInboundNumbers
Summary: List inbound numbers
Description: This operation is used to retrieve all the inbound numbers that are
avialble for a given country.

Syntax:
Nexmo.ListInboundNumbers (string country, [Optional]string
Search Pattern, [advanced][Optional]number pattern,
[advanced][Optional]string features, [advanced][Optional]number
size, [advanced][Optional]number index)

Parameters:
Name Type Summary Required Related
Action

1511 | P a g e
 Nexmo

country string Code in ISO True

(Country) 3166-1 alpha-2
format.
Search Pattern string Pick a pattern. False
Values: [1,
2, 3]
pattern number Number pattern False
(Pattern) to search for.
features string SMS or VOICE False
(Available
Features)
size number Default 10. False
(Result
Count)
index number Index in the False
(Page response.
Index)

Returns:
Type:ListNumbersResponse

SendTts
Summary: Send a speech file
Description: This operation is used to send a synthesized speech or recorded sound file
to a phone number.

Syntax:
Nexmo.SendTts (string to, [advanced][Optional]string from,
string text, [advanced][Optional]string lg,

1512 | P a g e
 Nexmo

[advanced][Optional]string voice, [advanced][Optional]number

repeat, [advanced][Optional]string machine_detection,
[advanced][Optional]number machine_timeout,
[advanced][Optional]string callback, [advanced][Optional]string
callback_method)

Parameters:
Name Type Summary Required Related
Action
to string International True
(To Phone format E.164.
Number)
from string Voice-enabled False
(From Phone Nexmo
Number) number.
text string Speech text. True
(Message)
lg string To synthesize False
(Language) the message in.
voice string Male or female. False
(Gender)Values:
[male, female]
repeat number Up to 10 times. False
(Repeat
Count)Values: [,
,,,,,,,,]
machine_detection string True or hangup. False
(Allow Machine
Detection)

1513 | P a g e
 Nexmo

machine_timeout number 400ms to False

(Machine 10000ms.
Timeout)
callback string(url) False
(Callback URL)
callback_method string GET or POST. False
(Callback
Method)Values:
[GET, POST]

Returns:
Type:ttsResponse

ListApplications
Summary: List applications
Description: Retrieves a list of all applications associated with your account.

Syntax:
Nexmo.ListApplications ([advanced][Optional]number page_size,
[advanced][Optional]number page_index)

Parameters:
Name Type Summary Required Related
Action
page_size number Items returned False
(Result on each call
Count) (Default 10).
page_index number Offset from first False
page (Default 0).

1514 | P a g e
 Nexmo

(Page
Index)

Returns:
Type:ListApplicationsResponse

CreateApplication
Summary: Create new application
Description: This operation is used to create a new application in your account.

Syntax:
Nexmo.CreateApplication (string name, string type,
[advanced]string answer_url, string event_url,
[advanced][Optional]string answer_method,
[advanced][Optional]string event_method)

Parameters:
Name Type Summary Required Related
Action
name string True
(Name)
type string True
(Type)
answer_url string Where your True
(Answer webhook
Url) delivers the
Nexmo Call
Control Object.

1515 | P a g e
 Nexmo

event_url string Started, ringing True

(Events Url) or complete
answer_method string HTTP method False
(Answer (Default GET).
Method)
event_method string HTTP method False
(Event (Default POST).
Method)

Returns:
Type:applicationResponse

GetApplication
Summary: Get application by Id
Description: This operation is used to retrieve information about a single application,
given its id.

Syntax:
Nexmo.GetApplication (string application_id)

Parameters:
Name Type Summary Required Related
Action
application_id string True
(Application
Id)

Returns:
Type:applicationResponse

1516 | P a g e
 Nexmo

UpdateApplication
Summary: Update an application
Description: This operation is used to modify an existing application in your account.

Syntax:
Nexmo.UpdateApplication (string application_id, string name,
string type, [advanced]string answer_url, string event_url,
[advanced][Optional]string answer_method,
[advanced][Optional]string event_method)

Parameters:
Name Type Summary Required Related
Action
application_id string True
(Application
Id)
name string True
(Name)
type string True
(Type)
answer_url string Where your True
(Answer webhook
Url) delivers the
Nexmo Call
Control Object.
event_url string Started, ringing True
(Events Url) or complete

1517 | P a g e
 Nexmo

answer_method string HTTP method False

(Answer (Default GET).
Method)
event_method string HTTP method False
(Event (Default POST).
Method)

Returns:
Type:applicationResponse

DeleteApplication
Summary: Delete an application
Description: This operation is used to delete an existing application in your account.

Syntax:
Nexmo.DeleteApplication (string application_id)

Parameters:
Name Type Summary Required Related
Action
application_id string True
(Application
Id)

Returns:
Type:common

1518 | P a g e
 Nexmo

applicationResponse
Summary:
Description:

Properties:
Name Type Summary
id string Nexmo application id.
Id
name string Application name.
Name
keys Keys keys

Keys
Summary:
Description: keys

Properties:
Name Type Summary
public_key string The public key used to validate the jwt in a
Keys https://en.wikipedia.org/wiki/JSON_Web_Token.

1519 | P a g e
 Nexmo

common
Summary:
Description:

Properties:
Name Type Summary
type string Human readable
Response message.
error_title string Title of error returned if
Error Text failed.
invalid_parameters Invalid_parameters message for invalid
parameters

Invalid_parameters
Summary:
Description: message for invalid parameters

Properties:
Name Type Summary
type string error string

1520 | P a g e
 Nexmo

ListApplicationsResponse
Summary:
Description:

Properties:
Name Type Summary
_embedded _embedded

_embedded
Summary:
Description:

Properties:
Name Type Summary
applications array of
(applicationResponse)

1521 | P a g e
 Nexmo

ListNumbersResponse
Summary:
Description:

Properties:
Name Type Summary
count integer(int32) Result count.
Count
numbers array of (NumbersItem) List of all numbers.
Numbers Array

NumbersItem
Summary:
Description:

Properties:
Name Type Summary
cost string Number cost.
Cost
country string ISO 3166-1 alpha-2
Country format.
msisdn string Inbound virtual number.
Inbound Number
type string Type of number.
Type

1522 | P a g e
 Nexmo

smsResponse
Summary:
Description:

Properties:
Name Type Summary
message-count number Number of parts the
Message Count message was split into.
messages array of (MessagesItem) Contains each message
Messages Array part.

MessagesItem
Summary:
Description:

Properties:
Name Type Summary
status number Shows how the SMS send
Status is processing.
message-id string Id of the SMS that was
Message Id submitted (8 to 16
characters).
to string Number your request was
To Phone Number sent to.
client-ref string The client-ref you set in
Client Reference the request.
remaining-balance string Balance in your account.
Remaining Balance The value is in EUR.

1523 | P a g e
 Nexmo

message-price string Amount charged for your

Message Price request. The value is in
EUR.
network string Mobile Country Code
Network Mobile Network Code
(MCCMNC) for the carrier
that to is registered with.
error-text string If an error occurred, this
Error Text explains what happened.

1524 | P a g e
 Nexmo

ttsResponse
Summary:
Description:

Properties:
Name Type Summary
call_id number Unique alphanumeric 32
Call Id character ID for this call.
to number Number of the user you
To Phone Number sent the TTS or TTS Prompt
to.
status number Response code for this TTS
Status or TTS prompt.
error_text string If an error occurred, this
Error Text explains what happened.

1525 | P a g e
 Notifications

Notifications
The notification service enables notifications created by a flow to go to your
email account or Microsoft Flow mobile app.

Status: Tier: Standard Version: 1.0

Actions:
Name Summary
SendNotification Send me a mobile notification
(NotificationDefinition
NotificationDefinition)
SendEmailNotification Send me an email notification
(NotificationEmailDefinition
NotificationEmailDefinition)

Triggers:
Name Summary

Objects:
Name Summary
NotificationDefinition
NotificationEmailDefinition

Actions:
SendNotification
Summary: Send me a mobile notification
Description: Sends a push notification to your Microsoft Flow mobile app.

1526 | P a g e
 Notifications

Syntax:
Notifications.SendNotification (NotificationDefinition
NotificationDefinition)

Parameters:
Name Type Summary Required Related
Action
NotificationDefinition NotificationDefinition True

Returns:

SendEmailNotification
Summary: Send me an email notification
Description: Sends an email notification to the account you signed in to Microsoft Flow
with.

Syntax:
Notifications.SendEmailNotification (NotificationEmailDefinition
NotificationEmailDefinition)

Parameters:
Name Type Summar Require Relate
y d d
Action
NotificationEmailDefiniti NotificationEmailDefiniti True
on on

1527 | P a g e
 Notifications

Returns:

1528 | P a g e
 Notifications

NotificationDefinition
Summary:
Description:

Properties:
Name Type Summary
notificationText string Create a notification
Text message
notificationLink NotificationLink Custom notification link

NotificationLink
Summary:
Description: Custom notification link

Properties:
Name Type Summary
uri string Include a link in the
Link notification
label string The display name for the
Link label link

1529 | P a g e
 Notifications

NotificationEmailDefinition
Summary:
Description:

Properties:
Name Type Summary
notificationSubject string Notification email subject
Subject
notificationBody string Notification email body
Body

1530 | P a g e
 Office 365 Outlook

Office 365 Outlook

Microsoft Office 365 is a cloud-based service that is designed to help meet
your organization's needs for robust security, reliability, and user productivity.

Status: Production Tier: Standard Version: 1.0

Actions:
Name Summary
GetEmails ([Optional]string Get emails
folderPath, [Optional]integer
top, [Optional]boolean
fetchOnlyUnread,
[Optional]boolean
includeAttachments,
[Optional]string searchQuery,
[internal][Optional]integer skip,
[internal][Optional]string
skipToken)
SendEmail (SendMessage Send an email
emailMessage)
SendDigestMail (DigestMessage Send digest email
digestMessage)
Move (string messageId, string Move email
folderPath)
Flag (string messageId) Flag email
DeleteEmail (string messageId) Delete email
MarkAsRead (string messageId) Mark as read

1531 | P a g e
 Office 365 Outlook

ReplyTo (string messageId, Reply to email

string comment,
[Optional]boolean replyAll)
GetAttachment (string Get attachment
messageId, string attachmentId)
GetRootMailFolders Get root mail folders
([internal][Optional]integer top,
[internal][Optional]integer skip)
GetChildMailFolders (string id, Get child mail folders
[advanced][Optional]integer
top,
[advanced][Optional]integer
skip)
GetDataSetsMetadata ()
ContactGetTable (string table) Get folder metadata
CalendarGetTable (string table) Get calendar metadata
GetTable (string dataset, string
table)
ODataStyleGetTable (string
dataset, string table)
SendMailWithOptions Send email with options
(OptionsEmailSubscription
optionsEmailSubscription)
SendApprovalMail Send approval email
(ApprovalEmailSubscription
approvalEmailSubscription)
DeleteApprovalMailSubscription Delete approval email subscription
(string id)

1532 | P a g e
 Office 365 Outlook

DeleteOptionsMailSubscription Delete options email subscription

(string id)
TestConnection () Tests the connection
CalendarGetTables () Get calendars
ODataStyleGetTables (string Get folders
dataset)
CalendarGetItems (string table, Get events (V1)
[advanced][Optional]string
$filter,
[advanced][Optional]string
$orderby,
[advanced][Optional]integer
$top,
[advanced][Optional]integer
$skip)
CalendarPostItem (string table, Create event (V1)
CalendarEventBackend item)
CalendarGetItem (string table, Get event (V1)
string id)
CalendarDeleteItem (string Delete event
table, string id)
CalendarPatchItem (string table, Update event (V1)
string id, CalendarEventBackend
item)
V2CalendarGetItems (string Get events (V2)
table,
[advanced][Optional]string
$filter,
[advanced][Optional]string

1533 | P a g e
 Office 365 Outlook

$orderby,
[advanced][Optional]integer
$top,
[advanced][Optional]integer
$skip)
V2CalendarPostItem (string Create event (V2)
table, CalendarEventClient
item)
V2CalendarGetItem (string Get event (V2)
table, string id)
V2CalendarPatchItem (string Update event (V2)
table, string id,
CalendarEventClient item)
ContactGetTables () Get contact folders
ContactGetItems (string table, Get contacts
[advanced][Optional]string
$filter,
[advanced][Optional]string
$orderby,
[advanced][Optional]integer
$top,
[advanced][Optional]integer
$skip)
ContactPostItem (string table, Create contact
Contact item)
ContactGetItem (string table, Get contact
string id)
ContactDeleteItem (string table, Delete contact
string id)

1534 | P a g e
 Office 365 Outlook

ContactPatchItem (string table, Update contact

string id, Contact item)
GetDataSets () Get datasets
ReceiveResponseGet (string Receives response from user
state)
ReceiveResponsePost (string Receives response from user
state)

Triggers:
Name Summary
OnUpcomingEvents (string table, When an upcoming event is starting soon
[advanced][Optional]integer
lookAheadTimeInMinutes)
OnNewEmail ([Optional]string When a new email arrives
folderPath, [advanced][Optional]string
to, [advanced][Optional]string from,
[advanced][Optional]string importance,
[advanced][Optional]boolean
fetchOnlyWithAttachment,
[advanced][Optional]boolean
includeAttachments,
[advanced][Optional]string subjectFilter)
OnFlaggedEmail ([Optional]string When an email is flagged
folderPath, [advanced][Optional]string
to, [advanced][Optional]string from,
[advanced][Optional]string importance,
[advanced][Optional]boolean
fetchOnlyWithAttachment,

1535 | P a g e
 Office 365 Outlook

[advanced][Optional]boolean
includeAttachments,
[advanced][Optional]string subjectFilter)
CalendarGetOnNewItems (string table, When a new event is created (V1)
[advanced][Optional]string $filter,
[advanced][Optional]string $orderby,
[advanced][Optional]integer $top,
[advanced][Optional]integer $skip)
CalendarGetOnUpdatedItems (string When an event is modified (V1)
table, [advanced][Optional]string $filter,
[advanced][Optional]string $orderby,
[advanced][Optional]integer $top,
[advanced][Optional]integer $skip)
ODataStyleGetOnNewItems (string When a new item is created in a table
dataset, string table,
[advanced][Optional]string $filter,
[advanced][Optional]string $orderby,
[advanced][Optional]integer $top,
[advanced][Optional]integer $skip)
ODataStyleCalendarGetOnUpdatedItems When an item is modified
(string dataset, string table,
[advanced][Optional]string $filter,
[advanced][Optional]string $orderby,
[advanced][Optional]integer $top,
[advanced][Optional]integer $skip)
V2CalendarGetOnNewItems (string When a new event is created (V2)
table, [advanced][Optional]string $filter,
[advanced][Optional]string $orderby,

1536 | P a g e
 Office 365 Outlook

[advanced][Optional]integer $top,
[advanced][Optional]integer $skip)
V2CalendarGetOnUpdatedItems (string When an event is modified (V2)
table, [advanced][Optional]string $filter,
[advanced][Optional]string $orderby,
[advanced][Optional]integer $top,
[advanced][Optional]integer $skip)
GetOnDeletedItems (string dataset,
string table, [advanced][Optional]string
$filter, [advanced][Optional]string
$orderby, [advanced][Optional]integer
$top, [advanced][Optional]integer $skip)
ODataStyleGetOnDeletedItems (string
dataset, string table,
[advanced][Optional]string $filter,
[advanced][Optional]string $orderby,
[advanced][Optional]integer $top,
[advanced][Optional]integer $skip)

Objects:
Name Summary
ApprovalEmailSubscription
ApprovalMessage
Attendee
BlobDataSetsMetadata
CalendarEventBackend
CalendarEventClient
CalendarEventClientReceive

1537 | P a g e
 Office 365 Outlook

CalendarEventList
CalendarEventListClientReceive
Contact
ContactList
DataSet
DataSetsList
DataSetsMetadata
DigestMessage
EmailAddress
FilePickerFolder
GeoCoordinates
Item
ItemBody
ItemsList
Location
MessageWithOptions
Object
OptionsEmailSubscription
PageListResponse[FilePickerFolder]
PatternedRecurrence
PhysicalAddress
ReceiveAttachment
ReceiveMessage
Recipient
RecurrencePattern
RecurrenceRange
ResponseStatus
SendAttachment

1538 | P a g e
 Office 365 Outlook

SendMessage
SubscriptionResponse
Table
TableCapabilitiesMetadata
TableFilterRestrictionsMetadata
TableMetadata
TablesList
TableSortRestrictionsMetadata
TabularDataSetsMetadata
TriggerBatchResponse[ReceiveMessage]

Actions:
GetEmails
Summary: Get emails
Description: This operation gets emails from a folder.

Syntax:
Office365Outlook.GetEmails ([Optional]string folderPath,
[Optional]integer top, [Optional]boolean fetchOnlyUnread,
[Optional]boolean includeAttachments, [Optional]string
searchQuery, [internal][Optional]integer skip,
[internal][Optional]string skipToken)

Parameters:
Name Type Summary Required Related
Action
folderPath string Mail folder to False
(Folder) retrieve emails

1539 | P a g e
 Office 365 Outlook

from (default:
'Inbox')
top integer(int32) Number of False
(Top) emails to
retrieve
(default: 10)
fetchOnlyUnread boolean Retrieve only False
(Fetch Only unread emails?
Unread
Messages)
includeAttachments boolean If set to true, False
(Include attachments will
Attachments) also be
retrieved along
with the email
searchQuery string Search query to False
(Search filter emails
Query)
skip integer(int32) Number of False
(Skip) emails to skip
(default: 0)
skipToken string Skip token to False
(Skip Token) fetch new page

Returns:
Type:array of (ReceiveMessage)

SendEmail
Summary: Send an email

1540 | P a g e
 Office 365 Outlook

Description: This operation sends an email message.

Syntax:
Office365Outlook.SendEmail (SendMessage emailMessage)

Parameters:
Name Type Summary Required Related
Action
emailMessage SendMessage Send Email True
Message

Returns:

SendDigestMail
Summary: Send digest email
Description: This operation sends a digest email.

Syntax:
Office365Outlook.SendDigestMail (DigestMessage digestMessage)

Parameters:
Name Type Summary Required Related
Action
digestMessage DigestMessage Send Email True
Message

Returns:

1541 | P a g e
 Office 365 Outlook

Move
Summary: Move email
Description: This operation moves an email to the specified folder.

Syntax:
Office365Outlook.Move (string messageId, string folderPath)

Parameters:
Name Type Summary Required Related
Action
messageId string Id of the email to True
(Message be moved
Id)
folderPath string Mail folder to True
(Folder) move the email
to

Returns:

Flag
Summary: Flag email
Description: This operation flags an email.

Syntax:
Office365Outlook.Flag (string messageId)

Parameters:

1542 | P a g e
 Office 365 Outlook

Name Type Summary Required Related

Action
messageId string Id of the email to True
(Message be flagged
Id)

Returns:

DeleteEmail
Summary: Delete email
Description: This operation deletes an email by id.

Syntax:
Office365Outlook.DeleteEmail (string messageId)

Parameters:
Name Type Summary Required Related
Action
messageId string Id of the email to True
(Message delete
Id)

Returns:

MarkAsRead
Summary: Mark as read
Description: This operation marks an email as having been read.

Syntax:

1543 | P a g e
 Office 365 Outlook

Office365Outlook.MarkAsRead (string messageId)

Parameters:
Name Type Summary Required Related
Action
messageId string Id of the email to True
(Message be marked as
Id) read

Returns:

ReplyTo
Summary: Reply to email
Description: This operation replies to an email.

Syntax:
Office365Outlook.ReplyTo (string messageId, string comment,
[Optional]boolean replyAll)

Parameters:
Name Type Summary Required Related
Action
messageId string Id of the email to True
(Message reply to
Id)
comment string Reply comment True
(Comment)
replyAll boolean Reply to all False
(Reply All) recipients

1544 | P a g e
 Office 365 Outlook

Returns:

GetAttachment
Summary: Get attachment
Description: This operation gets an email attachment by id.

Syntax:
Office365Outlook.GetAttachment (string messageId, string
attachmentId)

Parameters:
Name Type Summary Required Related
Action
messageId string Id of the email True
(Message
Id)
attachmentId string Id of the True
(Attachment attachment to
Id) download

Returns:
Type:string(binary)

GetRootMailFolders
Summary: Get root mail folders
Description: Get root mail folders

Syntax:

1545 | P a g e
 Office 365 Outlook

Office365Outlook.GetRootMailFolders ([internal][Optional]integer
top, [internal][Optional]integer skip)

Parameters:
Name Type Summary Required Related
Action
top integer(int64) Limit on the False
(Top) number of
results to return
skip integer(int64) Number of False
(Skip) results to skip

Returns:
Type:PageListResponse[FilePickerFolder]
Description: Response containing a list and next link

GetChildMailFolders
Summary: Get child mail folders
Description: Get child mail folders

Syntax:
Office365Outlook.GetChildMailFolders (string id,
[advanced][Optional]integer top, [advanced][Optional]integer
skip)

Parameters:
Name Type Summary Required Related
Action

1546 | P a g e
 Office 365 Outlook

id string Id of the parent True

(Folder Id) folder
top integer(int64) Limit on the False
(Top) number of
results to return
skip integer(int64) Number of False
(Skip) results to skip

Returns:
Type:PageListResponse[FilePickerFolder]
Description: Response containing a list and next link

GetDataSetsMetadata
Summary:
Description:

Syntax:
Office365Outlook.GetDataSetsMetadata ()

Returns:
Type:DataSetsMetadata

ContactGetTable
Summary: Get folder metadata
Description: This operation gets metadata for a contacts folder.

Syntax:
Office365Outlook.ContactGetTable (string table)

1547 | P a g e
 Office 365 Outlook

Parameters:
Name Type Summary Required Related Action
table string Select a True ContactGetTables
(Folder id) contacts folder

Returns:
Type:TableMetadata

CalendarGetTable
Summary: Get calendar metadata
Description: This operation gets metadata for a calendar

Syntax:
Office365Outlook.CalendarGetTable (string table)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Folder id) calendar

Returns:
Type:TableMetadata

GetTable
Summary:
Description:

Syntax:
Office365Outlook.GetTable (string dataset, string table)

1548 | P a g e
 Office 365 Outlook

Parameters:
Name Type Summary Required Related
Action
dataset string True GetDataSets

table string True

Returns:
Type:TableMetadata

ODataStyleGetTable
Summary:
Description:

Syntax:
Office365Outlook.ODataStyleGetTable (string dataset, string
table)

Parameters:
Name Type Summary Required Related
Action
dataset string True

table string True

Returns:

1549 | P a g e
 Office 365 Outlook

Type:TableMetadata

SendMailWithOptions
Summary: Send email with options
Description: This operation sends an email with multiple options and waits for the
recipient to respond back with one of the options.

Syntax:
Office365Outlook.SendMailWithOptions (OptionsEmailSubscription
optionsEmailSubscription)

Parameters:
Name Type Summary Require Relate
d d
Action
optionsEmailSubscripti OptionsEmailSubscripti Model for True
on on Options
Email
Subscriptio
n

Returns:
Type:SubscriptionResponse
Description: Model for Approval Email Subscription

SendApprovalMail
Summary: Send approval email
Description: This operation sends an approval email and waits for a response from the
recipient.

1550 | P a g e
 Office 365 Outlook

Syntax:
Office365Outlook.SendApprovalMail (ApprovalEmailSubscription
approvalEmailSubscription)

Parameters:
Name Type Summary Require Relate
d d
Action
approvalEmailSubscripti ApprovalEmailSubscripti Model for True
on on Approval
Email
Subscriptio
n

Returns:
Type:SubscriptionResponse
Description: Model for Approval Email Subscription

DeleteApprovalMailSubscription
Summary: Delete approval email subscription
Description: This operation deletes a subscription of approval email.

Syntax:
Office365Outlook.DeleteApprovalMailSubscription (string id)

Parameters:
Name Type Summary Required Related
Action

1551 | P a g e
 Office 365 Outlook

id string Id of subscription True

(Id of to be deleted
subscription
to be
deleted)

Returns:

DeleteOptionsMailSubscription
Summary: Delete options email subscription
Description: This operation deletes a subscription of options email

Syntax:
Office365Outlook.DeleteOptionsMailSubscription (string id)

Parameters:
Name Type Summary Required Related
Action
id string Id of subscription True
(Id of to be deleted
subscription
to be
deleted)

Returns:

TestConnection
Summary: Tests the connection
Description: Tests the connection

1552 | P a g e
 Office 365 Outlook

Syntax:
Office365Outlook.TestConnection ()

Returns:

CalendarGetTables
Summary: Get calendars
Description: This operation lists available calendars.

Syntax:
Office365Outlook.CalendarGetTables ()

Returns:
Type:TablesList

ODataStyleGetTables
Summary: Get folders
Description: This operation lists available contact folders.

Syntax:
Office365Outlook.ODataStyleGetTables (string dataset)

Parameters:
Name Type Summary Required Related
Action
dataset string dataset name True
(Dataset)

1553 | P a g e
 Office 365 Outlook

Returns:
Type:TablesList

CalendarGetItems
Summary: Get events (V1)
Description: This operation gets events from a calendar. (V1)

Syntax:
Office365Outlook.CalendarGetItems (string table,
[advanced][Optional]string $filter, [advanced][Optional]string
$orderby, [advanced][Optional]integer $top,
[advanced][Optional]integer $skip)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar id) calendar
$filter string An ODATA False
(Filter Query) filter query to
restrict the
entries
returned
$orderby string An ODATA False
(Order By) orderBy
query for
specifying the
order of
entries

1554 | P a g e
 Office 365 Outlook

$top integer(int32) Total number False

(Top Count) of entries to
retrieve
(default = all)
$skip integer(int32) Number of False
(Skip Count) entries to skip
(default = 0)

Returns:
Type:CalendarEventList
Description: The list of calendar items

CalendarPostItem
Summary: Create event (V1)
Description: This operation creates a new event in a calendar. (V1)

Syntax:
Office365Outlook.CalendarPostItem (string table,
CalendarEventBackend item)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar id) calendar
item CalendarEventBackend Connector True
specific
calendar
event
model class

1555 | P a g e
 Office 365 Outlook

for the
backend

Returns:
Type:CalendarEventBackend
Description: Connector specific calendar event model class for the backend

CalendarGetItem
Summary: Get event (V1)
Description: This operation gets a specific event from a calendar. (V1)

Syntax:
Office365Outlook.CalendarGetItem (string table, string id)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar calendar
id)
id string Select an True
(Item id) event

Returns:
Type:CalendarEventBackend
Description: Connector specific calendar event model class for the backend

CalendarDeleteItem
Summary: Delete event
Description: This operation deletes an event in a calendar.

1556 | P a g e
 Office 365 Outlook

Syntax:
Office365Outlook.CalendarDeleteItem (string table, string id)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar calendar
id)
id string Select an True
(Id) event

Returns:

CalendarPatchItem
Summary: Update event (V1)
Description: This operation updates an event in a calendar. (V1)

Syntax:
Office365Outlook.CalendarPatchItem (string table, string id,
CalendarEventBackend item)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar id) calendar
id string Select an True
(Id) event

1557 | P a g e
 Office 365 Outlook

item CalendarEventBackend Connector True

specific
calendar
event
model class
for the
backend

Returns:
Type:CalendarEventBackend
Description: Connector specific calendar event model class for the backend

V2CalendarGetItems
Summary: Get events (V2)
Description: This operation gets events from a calendar. (V2)

Syntax:
Office365Outlook.V2CalendarGetItems (string table,
[advanced][Optional]string $filter, [advanced][Optional]string
$orderby, [advanced][Optional]integer $top,
[advanced][Optional]integer $skip)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar id) calendar
$filter string An ODATA False
(Filter Query) filter query to
restrict the

1558 | P a g e
 Office 365 Outlook

entries
returned
$orderby string An ODATA False
(Order By) orderBy
query for
specifying the
order of
entries
$top integer(int32) Total number False
(Top Count) of entries to
retrieve
(default = all)
$skip integer(int32) Number of False
(Skip Count) entries to skip
(default = 0)

Returns:
Type:CalendarEventListClientReceive
Description: The list of calendar items

V2CalendarPostItem
Summary: Create event (V2)
Description: This operation creates a new event in a calendar. (V2)

Syntax:
Office365Outlook.V2CalendarPostItem (string table,
CalendarEventClient item)

Parameters:

1559 | P a g e
 Office 365 Outlook

Name Type Summary Required Related Action

table string Select a True CalendarGetTables
(Calendar id) calendar
item CalendarEventClient Connector True
specific
calendar
event model
class for the
client

Returns:
Type:CalendarEventClientReceive
Description: Connector specific calendar event model class for the client

V2CalendarGetItem
Summary: Get event (V2)
Description: This operation gets a specific event from a calendar. (V2)

Syntax:
Office365Outlook.V2CalendarGetItem (string table, string id)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar calendar
id)
id string Select an True
(Item id) event

1560 | P a g e
 Office 365 Outlook

Returns:
Type:CalendarEventClientReceive
Description: Connector specific calendar event model class for the client

V2CalendarPatchItem
Summary: Update event (V2)
Description: This operation updates an event in a calendar. (V2)

Syntax:
Office365Outlook.V2CalendarPatchItem (string table, string id,
CalendarEventClient item)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar id) calendar
id string Select an True
(Id) event
item CalendarEventClient Connector True
specific
calendar
event model
class for the
client

Returns:
Type:CalendarEventClientReceive
Description: Connector specific calendar event model class for the client

1561 | P a g e
 Office 365 Outlook

ContactGetTables
Summary: Get contact folders
Description: This operation lists available contacts folders.

Syntax:
Office365Outlook.ContactGetTables ()

Returns:
Type:TablesList

ContactGetItems
Summary: Get contacts
Description: This operation gets contacts from a contacts folder.

Syntax:
Office365Outlook.ContactGetItems (string table,
[advanced][Optional]string $filter, [advanced][Optional]string
$orderby, [advanced][Optional]integer $top,
[advanced][Optional]integer $skip)

Parameters:
Name Type Summary Required Related Action
table string Unique True ContactGetTables
(Folder id) identifier of
the contacts
folder to
retrieve
$filter string An ODATA False
(Filter Query) filter query to

1562 | P a g e
 Office 365 Outlook

restrict the
entries
returned
$orderby string An ODATA False
(Order By) orderBy query
for specifying
the order of
entries
$top integer(int32) Total number False
(Top Count) of entries to
retrieve
(default = all)
$skip integer(int32) Number of False
(Skip Count) entries to skip
(default = 0)

Returns:
Type:ContactList
Description: The list of contacts

ContactPostItem
Summary: Create contact
Description: This operation creates a new contact in a contacts folder.

Syntax:
Office365Outlook.ContactPostItem (string table, Contact item)

Parameters:
Name Type Summary Required Related Action

1563 | P a g e
 Office 365 Outlook

table string Select a True ContactGetTables

(Folder id) contacts folder
item Contact Contact True

Returns:
Type:Contact
Description: Contact

ContactGetItem
Summary: Get contact
Description: This operation gets a specific contact from a contacts folder.

Syntax:
Office365Outlook.ContactGetItem (string table, string id)

Parameters:
Name Type Summary Required Related Action
table string Select a True ContactGetTables
(Folder id) contacts folder
id string Unique True
(Item id) identifier of a
contact to
retrieve

Returns:
Type:Contact
Description: Contact

1564 | P a g e
 Office 365 Outlook

ContactDeleteItem
Summary: Delete contact
Description: This operation deletes a contact from a contacts folder.

Syntax:
Office365Outlook.ContactDeleteItem (string table, string id)

Parameters:
Name Type Summary Required Related Action
table string Select a True ContactGetTables
(Folder id) contacts folder
id string Unique True
(Id) identifier of
contact to
delete

Returns:

ContactPatchItem
Summary: Update contact
Description: This operation updates a contact in a contacts folder.

Syntax:
Office365Outlook.ContactPatchItem (string table, string id,
Contact item)

Parameters:
Name Type Summary Required Related Action

1565 | P a g e
 Office 365 Outlook

table string Select a True ContactGetTables

(Folder id) contacts folder
id string Unique True
(Id) identifier of
contact to
update
item Contact Contact True

Returns:
Type:Contact
Description: Contact

GetDataSets
Summary: Get datasets
Description: This operation gets Contacts or Calendars

Syntax:
Office365Outlook.GetDataSets ()

Returns:
Type:DataSetsList

ReceiveResponseGet
Summary: Receives response from user
Description: This operation gets a response from the user.

Syntax:
Office365Outlook.ReceiveResponseGet (string state)

1566 | P a g e
 Office 365 Outlook

Parameters:
Name Type Summary Required Related
Action
state string callback state True
(callback
state)

Returns:
Type:string

ReceiveResponsePost
Summary: Receives response from user
Description: This operation gets a response from the user.

Syntax:
Office365Outlook.ReceiveResponsePost (string state)

Parameters:
Name Type Summary Required Related
Action
state string callback state True
(callback
state)

Returns:
Type:string

1567 | P a g e
 Office 365 Outlook

Triggers:
Trigger OnUpcomingEvents
Summary: When an upcoming event is starting soon
Description: This operation triggers a flow when an upcoming calendar event is
starting.

Syntax:
Office365Outlook.OnUpcomingEvents (string table,
[advanced][Optional]integer lookAheadTimeInMinutes)

Parameters:
Name Type Summary Require Related Action
d
table string Unique True CalendarGetTable
(Calendar id) identifier s
of the
calendar
lookAheadTimeInMinute integer(int32 Time (in False
s ) minutes)
(Look ahead to look
time) ahead for
upcomin
g events

Returns:
Type:CalendarEventList
Description: The list of calendar items

1568 | P a g e
 Office 365 Outlook

Trigger OnNewEmail
Summary: When a new email arrives
Description: This operation triggers a flow when a new email arrives

Syntax:
Office365Outlook.OnNewEmail ([Optional]string folderPath,
[advanced][Optional]string to, [advanced][Optional]string from,
[advanced][Optional]string importance,
[advanced][Optional]boolean fetchOnlyWithAttachment,
[advanced][Optional]boolean includeAttachments,
[advanced][Optional]string subjectFilter)

Parameters:
Name Type Summary Require Relate
d d
Action
folderPath string Mail folder False
(Folder) to retrieve
from
(default:
Inbox)
to string(email) Recipient False
(To) email
addresses
(If any of
the
addresses
match, the
trigger will
run)

1569 | P a g e
 Office 365 Outlook

from string(email) From False

(From) address
importance string Importance False
(Importance)Values of the email
: [Any, Low, (Any, High,
Normal, High] Normal,
Low)
(default:
Any)
fetchOnlyWithAttachmen boolean Retrieve False
t (Has Attachment) only emails
with an
attachment
includeAttachments boolean Include False
(Include attachment
Attachments) s
subjectFilter string String to False
(Subject Filter) look for in
the subject

Returns:
Type:TriggerBatchResponse[ReceiveMessage]

Trigger OnFlaggedEmail
Summary: When an email is flagged
Description: This operation triggers a flow when an email is flagged

Syntax:

1570 | P a g e
 Office 365 Outlook

Office365Outlook.OnFlaggedEmail ([Optional]string folderPath,

[advanced][Optional]string to, [advanced][Optional]string from,
[advanced][Optional]string importance,
[advanced][Optional]boolean fetchOnlyWithAttachment,
[advanced][Optional]boolean includeAttachments,
[advanced][Optional]string subjectFilter)

Parameters:
Name Type Summary Require Relate
d d
Action
folderPath string Mail folder False
(Folder) to retrieve
from
(default:
Inbox)
to string(email) Recipient False
(To) email
addresses
(If any of
the
addresses
match, the
trigger will
run)
from string(email) From False
(From) address
importance string Importance False
of the email
(Any, High,

1571 | P a g e
 Office 365 Outlook

(Importance)Values Normal,
: [Any, Low, Low)
Normal, High] (default:
Any)
fetchOnlyWithAttachmen boolean Retrieve False
t (Has Attachment) only emails
with an
attachment
includeAttachments boolean Include False
(Include attachment
Attachments) s
subjectFilter string String to False
(Subject Filter) look for in
the subject

Returns:
Type:TriggerBatchResponse[ReceiveMessage]

Trigger CalendarGetOnNewItems
Summary: When a new event is created (V1)
Description: This operation triggers a flow when a new event is created in a calendar.
(V1)

Syntax:
Office365Outlook.CalendarGetOnNewItems (string table,
[advanced][Optional]string $filter, [advanced][Optional]string
$orderby, [advanced][Optional]integer $top,
[advanced][Optional]integer $skip)

Parameters:

1572 | P a g e
 Office 365 Outlook

Name Type Summary Required Related Action

table string Select a True CalendarGetTables
(Calendar id) calendar
$filter string An ODATA False
(Filter Query) filter query to
restrict the
entries
returned
$orderby string An ODATA False
(Order By) orderBy
query for
specifying the
order of
entries
$top integer(int32) Total number False
(Top Count) of entries to
retrieve
(default = all)
$skip integer(int32) Number of False
(Skip Count) entries to skip
(default = 0)

Returns:
Type:CalendarEventList
Description: The list of calendar items

Trigger CalendarGetOnUpdatedItems
Summary: When an event is modified (V1)

1573 | P a g e
 Office 365 Outlook

Description: This operation triggers a flow when an event is modified in a calendar.

(V1)

Syntax:
Office365Outlook.CalendarGetOnUpdatedItems (string table,
[advanced][Optional]string $filter, [advanced][Optional]string
$orderby, [advanced][Optional]integer $top,
[advanced][Optional]integer $skip)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar id) calendar
$filter string An ODATA False
(Filter Query) filter query to
restrict the
entries
returned
$orderby string An ODATA False
(Order By) orderBy
query for
specifying the
order of
entries
$top integer(int32) Total number False
(Top Count) of entries to
retrieve
(default = all)

1574 | P a g e
 Office 365 Outlook

$skip integer(int32) Number of False

(Skip Count) entries to skip
(default = 0)

Returns:
Type:CalendarEventList
Description: The list of calendar items

Trigger ODataStyleGetOnNewItems
Summary: When a new item is created in a table
Description: This operation triggers a flow when a new item is created in a table.

Syntax:
Office365Outlook.ODataStyleGetOnNewItems (string dataset, string
table, [advanced][Optional]string $filter,
[advanced][Optional]string $orderby, [advanced][Optional]integer
$top, [advanced][Optional]integer $skip)

Parameters:
Name Type Summary Required Related
Action
dataset string dataset name True
(Dataset)
table string table name True
(Calendar id)
$filter string An ODATA filter False
(Filter Query) query to restrict
the entries
returned

1575 | P a g e
 Office 365 Outlook

$orderby string An ODATA False

(Order By) orderBy query
for specifying
the order of
entries
$top integer(int32) Total number of False
(Top Count) entries to
retrieve (default
= all)
$skip integer(int32) Number of False
(Skip Count) entries to skip
(default = 0)

Returns:
Type:CalendarEventList
Description: The list of calendar items

Trigger ODataStyleCalendarGetOnUpdatedItems
Summary: When an item is modified
Description: This operation triggers a flow when an item is modified in a table.

Syntax:
Office365Outlook.ODataStyleCalendarGetOnUpdatedItems (string
dataset, string table, [advanced][Optional]string $filter,
[advanced][Optional]string $orderby, [advanced][Optional]integer
$top, [advanced][Optional]integer $skip)

Parameters:

1576 | P a g e
 Office 365 Outlook

Name Type Summary Required Related

Action
dataset string dataset name True
(Dataset)
table string table name True
(Calendar id)
$filter string An ODATA filter False
(Filter Query) query to restrict
the entries
returned
$orderby string An ODATA False
(Order By) orderBy query
for specifying
the order of
entries
$top integer(int32) Total number of False
(Top Count) entries to
retrieve (default
= all)
$skip integer(int32) Number of False
(Skip Count) entries to skip
(default = 0)

Returns:
Type:CalendarEventList
Description: The list of calendar items

Trigger V2CalendarGetOnNewItems
Summary: When a new event is created (V2)

1577 | P a g e
 Office 365 Outlook

Description: This operation triggers a flow when a new event is created in a calendar.
(V2)

Syntax:
Office365Outlook.V2CalendarGetOnNewItems (string table,
[advanced][Optional]string $filter, [advanced][Optional]string
$orderby, [advanced][Optional]integer $top,
[advanced][Optional]integer $skip)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar id) calendar
$filter string An ODATA False
(Filter Query) filter query to
restrict the
entries
returned
$orderby string An ODATA False
(Order By) orderBy
query for
specifying the
order of
entries
$top integer(int32) Total number False
(Top Count) of entries to
retrieve
(default = all)

1578 | P a g e
 Office 365 Outlook

$skip integer(int32) Number of False

(Skip Count) entries to skip
(default = 0)

Returns:
Type:CalendarEventListClientReceive
Description: The list of calendar items

Trigger V2CalendarGetOnUpdatedItems
Summary: When an event is modified (V2)
Description: This operation triggers a flow when an event is modified in a calendar.
(V2)

Syntax:
Office365Outlook.V2CalendarGetOnUpdatedItems (string table,
[advanced][Optional]string $filter, [advanced][Optional]string
$orderby, [advanced][Optional]integer $top,
[advanced][Optional]integer $skip)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar id) calendar
$filter string An ODATA False
(Filter Query) filter query to
restrict the
entries
returned

1579 | P a g e
 Office 365 Outlook

$orderby string An ODATA False

(Order By) orderBy
query for
specifying the
order of
entries
$top integer(int32) Total number False
(Top Count) of entries to
retrieve
(default = all)
$skip integer(int32) Number of False
(Skip Count) entries to skip
(default = 0)

Returns:
Type:CalendarEventListClientReceive
Description: The list of calendar items

Trigger GetOnDeletedItems
Summary:
Description:

Syntax:
Office365Outlook.GetOnDeletedItems (string dataset, string
table, [advanced][Optional]string $filter,
[advanced][Optional]string $orderby, [advanced][Optional]integer
$top, [advanced][Optional]integer $skip)

Parameters:

1580 | P a g e
 Office 365 Outlook

Name Type Summary Required Related

Action
dataset string True GetDataSets

table string True

$filter string An ODATA filter False

(Filter Query) query to
restrict the
entries
returned
$orderby string An ODATA False
(Order By) orderBy query
for specifying
the order of
entries
$top integer(int32) Total number False
(Top Count) of entries to
retrieve
(default = all)
$skip integer(int32) Number of False
(Skip Count) entries to skip
(default = 0)

Returns:
Type:ItemsList

Trigger ODataStyleGetOnDeletedItems
Summary:

1581 | P a g e
 Office 365 Outlook

Description:

Syntax:
Office365Outlook.ODataStyleGetOnDeletedItems (string dataset,
string table, [advanced][Optional]string $filter,
[advanced][Optional]string $orderby, [advanced][Optional]integer
$top, [advanced][Optional]integer $skip)

Parameters:
Name Type Summary Required Related
Action
dataset string True

table string True

$filter string An ODATA filter False

(Filter Query) query to restrict
the entries
returned
$orderby string An ODATA False
(Order By) orderBy query
for specifying
the order of
entries
$top integer(int32) Total number of False
(Top Count) entries to
retrieve (default
= all)

1582 | P a g e
 Office 365 Outlook

$skip integer(int32) Number of False

(Skip Count) entries to skip
(default = 0)

Returns:
Type:ItemsList

1583 | P a g e
 Office 365 Outlook

ApprovalEmailSubscription
Summary:
Description: Model for Approval Email Subscription

Properties:
Name Type Summary
NotificationUrl string Gets or sets callback url
to flow engine. It is
expected as part of
request
Message ApprovalMessage Approval Email Message.
This is the message
expected as part of user
input

1584 | P a g e
 Office 365 Outlook

ApprovalMessage
Summary:
Description: Approval Email Message. This is the message expected as part of user
input

Properties:
Name Type Summary
To string(email) Specify email addresses
To separated by semicolons
like
[email protected]
Subject string Subject
Subject
Options string User Options
User Options
Body string Body
Body
Importance string Importance Values: [Low,
Importance Normal, High]
Attachments array of (SendAttachment) Attachments
Attachments

1585 | P a g e
 Office 365 Outlook

Attendee
Summary:
Description:

Properties:
Name Type Summary
Status ResponseStatus

Type string Values: [Required,

Optional, Resource]
EmailAddress EmailAddress

1586 | P a g e
 Office 365 Outlook

BlobDataSetsMetadata
Summary:
Description:

Properties:
Name Type Summary
source string

displayName string

urlEncoding string

1587 | P a g e
 Office 365 Outlook

CalendarEventBackend
Summary:
Description: Connector specific calendar event model class for the backend

Properties:
Name Type Summary
Id string The Event's unique
Id identifier
Attendees array of (Attendee) List of attendees for the
Attendees event
Body ItemBody

BodyPreview string The preview of the

Body preview message associated with
the event
Categories array of (string) The categories associated
Categories with the event
ChangeKey string This property identifies
Change key the version of the event
object. Every time the
event is changed,
ChangeKey changes as
well.
DateTimeCreated string(date-time) The date and time that
Created time the event was created
DateTimeLastModified string(date-time) The date and time that
Last modified time the event was last
modified
End string(date-time) The end time of the event

1588 | P a g e
 Office 365 Outlook

End time
EndTimeZone string This property specifies
End time zone the time zone of the
meeting end time. The
value must be as defined
in Windows (example:
'Pacific Standard Time').
HasAttachments boolean Set to true if the event
Has attachments? has attachments
Importance string The importance of the
Importance event: Low, Normal, or
High Values: [Low,
Normal, High]
IsAllDay boolean Set to true if the event
Is all day event? lasts all day
IsCancelled boolean Set to true if the event
Is cancelled? has been canceled
IsOrganizer boolean Set to true if the message
Is Organizer sender is also the
organizer
Location Location

Organizer Recipient

Recurrence PatternedRecurrence

Reminder integer(int32) Time in minutes before

Reminder event start to remind

1589 | P a g e
 Office 365 Outlook

ResponseRequested boolean Set to true if the sender

Response requested would like a response
when the event is
accepted or declined
ResponseStatus ResponseStatus

SeriesMasterId string Unique identifier for

Series master id Series Master event type
ShowAs string Shows as free or busy
Show as Values: [Free, Tentative,
Busy, Oof,
WorkingElsewhere,
Unknown]
Start string(date-time) The start time of the
Start time event
StartTimeZone string This property specifies
Start time zone the time zone of the
meeting start time. The
value must be as defined
in Windows (example:
'Pacific Standard Time').
Subject string Event subject
Subject
Type string The event type: Single
Type Instance, Occurrence,
Exception, or Series
Master Values:
[SingleInstance,

1590 | P a g e
 Office 365 Outlook

Occurrence, Exception,
SeriesMaster]
WebLink string The preview of the
Web link message associated with
the event

1591 | P a g e
 Office 365 Outlook

CalendarEventClient
Summary:
Description: Connector specific calendar event model class for the client

Properties:
Name Type Summary
Subject string Event subject
Subject
Start string(date-time) Start time of the event
Start time (example: '2016-11-
01T14:30:00')
End string(date-time) End time of the event
End time (example: '2016-11-
01T15:30:00')
TimeZone string Time zone of the event,
Time zone specified as a time zone
index value (example:
'Pacific Standard Time')
RequiredAttendees string(email) Required attendees for the
Required attendees event
OptionalAttendees string(email) Optional attendees for the
Optional attendees event
Body string Body of the message
Body associated with the event
IsHtml boolean Set to true if the body is
Is HTML Html
Location string Location of the event
Location

1592 | P a g e
 Office 365 Outlook

Importance string The importance of the

Importance event: Low, Normal, or
High Values: [Low,
Normal, High]
IsAllDay boolean Set to true if the event
Is all day event? lasts all day
Recurrence string The recurrence pattern for
Recurrence the event Values: [None,
Daily, Weekly, Monthly,
Yearly]
Reminder integer(int32) Time in minutes before
Reminder event start to remind
ShowAs string Status to show during the
Show as event Values: [Free,
Tentative, Busy, Oof,
WorkingElsewhere,
Unknown]

1593 | P a g e
 Office 365 Outlook

CalendarEventClientReceive
Summary:
Description: Connector specific calendar event model class for the client

Properties:
Name Type Summary
Id string The event's unique
Id identifier
DateTimeCreated string(date-time) The date and time that the
Created time event was created
DateTimeLastModified string(date-time) The date and time that the
Last modified time event was last modified
Subject string Event subject
Subject
Start string(date-time) Start time of the event
Start time (example: '2016-11-
01T14:30:00')
End string(date-time) End time of the event
End time (example: '2016-11-
01T15:30:00')
TimeZone string Time zone of the event,
Time zone specified as a time zone
index value (example:
'Pacific Standard Time')
RequiredAttendees string(email) Required attendees for
Required attendees the event
OptionalAttendees string(email) Optional attendees for the
Optional attendees event

1594 | P a g e
 Office 365 Outlook

Body string Body of the message

Body associated with the event
IsHtml boolean Set to true if the body is
Is HTML Html
Location string Location of the event
Location
Importance string The importance of the
Importance event: Low, Normal, or
High Values: [Low,
Normal, High]
IsAllDay boolean Set to true if the event
Is all day event? lasts all day
Recurrence string The recurrence pattern for
Recurrence the event Values: [None,
Daily, Weekly, Monthly,
Yearly]
Reminder integer(int32) Time in minutes before
Reminder event start to remind
ShowAs string Status to show during the
Show as event Values: [Free,
Tentative, Busy, Oof,
WorkingElsewhere,
Unknown]

1595 | P a g e
 Office 365 Outlook

CalendarEventList
Summary:
Description: The list of calendar items

Properties:
Name Type Summary
value array of List of calendar items
(CalendarEventBackend)

1596 | P a g e
 Office 365 Outlook

CalendarEventListClientReceive
Summary:
Description: The list of calendar items

Properties:
Name Type Summary
value array of List of calendar items
(CalendarEventClientReceive)

1597 | P a g e
 Office 365 Outlook

Contact
Summary:
Description: Contact

Properties:
Name Type Summary
Id string The contact's unique
Id identifier.
ParentFolderId string The ID of the contact's
Parent folder id parent folder
Birthday string(date-time) The contact's birthday
Birthday
FileAs string The name the contact is
File as filed under
DisplayName string The contact's display
Display Name name
GivenName string The contact's given name
Given name
Initials string The contact's initials
Initials
MiddleName string The contact's middle
Middle name name
NickName string The contact's nickname
Nickname
Surname string The contact's surname
Surname
Title string The contact's title
Title
Generation string The contact's generation

1598 | P a g e
 Office 365 Outlook

Generation
EmailAddresses array of (EmailAddress) The contact's email
Email addresses addresses
ImAddresses array of (string) The contact's instant
IM addresses messaging (IM)
addresses
JobTitle string The contact's job title
JobTitle
CompanyName string The name of the
Company name contact's company
Department string The contact's
Department department
OfficeLocation string The location of the
Office location contact's office
Profession string The contact's profession
Profession
BusinessHomePage string The business home page
Business home page of the contact
AssistantName string The name of the
Assistant name contact's assistant
Manager string The name of the
Manager contact's manager
HomePhones array of (string) The contact's home
Home phones phone numbers
BusinessPhones array of (string) The contact's business
Business phones phone numbers
MobilePhone1 string The contact's mobile
Mobile phone phone number
HomeAddress PhysicalAddress

1599 | P a g e
 Office 365 Outlook

BusinessAddress PhysicalAddress

OtherAddress PhysicalAddress

YomiCompanyName string The phonetic Japanese

Yomi company name company name of the
contact
YomiGivenName string The phonetic Japanese
Yomi given name given name (first name)
of the contact
YomiSurname string The phonetic Japanese
Yomi surname surname (last name) of
the contact
Categories array of (string) The categories
Categories associated with the
contact
ChangeKey string Identifies the version of
Change key the event object
DateTimeCreated string(date-time) The time the contact was
Created time created
DateTimeLastModified string(date-time) The time the contact was
Last modified time modified

1600 | P a g e
 Office 365 Outlook

ContactList
Summary:
Description: The list of contacts

Properties:
Name Type Summary
value array of (Contact) List of contacts

1601 | P a g e
 Office 365 Outlook

DataSet
Summary:
Description:

Properties:
Name Type Summary
Name string

DisplayName string

1602 | P a g e
 Office 365 Outlook

DataSetsList
Summary:
Description:

Properties:
Name Type Summary
value array of (DataSet)

1603 | P a g e
 Office 365 Outlook

DataSetsMetadata
Summary:
Description:

Properties:
Name Type Summary
tabular TabularDataSetsMetadata

blob BlobDataSetsMetadata

1604 | P a g e
 Office 365 Outlook

DigestMessage
Summary:
Description: Send Email Message

Properties:
Name Type Summary
Subject string Subject
Subject
Body string Body
Body
Importance string Importance Values: [Low,
Importance Normal, High]
Digest array of (string) Digest

Attachments array of (SendAttachment) Attachments

Attachments
To string(email) To
To

1605 | P a g e
 Office 365 Outlook

EmailAddress
Summary:
Description:

Properties:
Name Type Summary
Name string

Address string

1606 | P a g e
 Office 365 Outlook

FilePickerFolder
Summary:
Description: Folder

Properties:
Name Type Summary
Id string Id

DisplayName string Display name

Path string Path

IsFolder boolean Is Folder?

1607 | P a g e
 Office 365 Outlook

GeoCoordinates
Summary:
Description:

Properties:
Name Type Summary
Altitude number(double)

Latitude number(double)

Longitude number(double)

Accuracy number(double)

AltitudeAccuracy number(double)

1608 | P a g e
 Office 365 Outlook

Item
Summary:
Description:

Properties:
Name Type Summary
ItemInternalId string

1609 | P a g e
 Office 365 Outlook

ItemBody
Summary:
Description:

Properties:
Name Type Summary
ContentType string Values: [Text, HTML]

Content string

1610 | P a g e
 Office 365 Outlook

ItemsList
Summary:
Description:

Properties:
Name Type Summary
value array of (Item)

1611 | P a g e
 Office 365 Outlook

Location
Summary:
Description:

Properties:
Name Type Summary
DisplayName string

Address PhysicalAddress

Coordinates GeoCoordinates

1612 | P a g e
 Office 365 Outlook

MessageWithOptions
Summary:
Description: User Options Email Message. This is the message expected as part of user
input

Properties:
Name Type Summary
To string(email) Specify email addresses
To separated by semicolons
like
[email protected]
Subject string Subject of the email
Subject
Options string List of comma separated
User Options options for the email
response
Body string Body of the email
Body
Importance string Importance Values: [Low,
Importance Normal, High]
Attachments array of (SendAttachment) Attachments
Attachments

1613 | P a g e
 Office 365 Outlook

Object
Summary:
Description:

Properties:
Name Type Summary

1614 | P a g e
 Office 365 Outlook

OptionsEmailSubscription
Summary:
Description: Model for Options Email Subscription

Properties:
Name Type Summary
NotificationUrl string Gets or sets callback url
to flow engine. It is
expected as part of
request
Message MessageWithOptions User Options Email
Message. This is the
message expected as
part of user input

1615 | P a g e
 Office 365 Outlook

PageListResponse[FilePickerFolder]
Summary:
Description: Response containing a list and next link

Properties:
Name Type Summary
value array of (FilePickerFolder) Value

nextLink string Next page link

1616 | P a g e
 Office 365 Outlook

PatternedRecurrence
Summary:
Description:

Properties:
Name Type Summary
Pattern RecurrencePattern

Range RecurrenceRange

1617 | P a g e
 Office 365 Outlook

PhysicalAddress
Summary:
Description:

Properties:
Name Type Summary
Street string

City string

State string

CountryOrRegion string

PostalCode string

1618 | P a g e
 Office 365 Outlook

ReceiveAttachment
Summary:
Description: Receive Attachment

Properties:
Name Type Summary
Id string The attachment Id
Attachment Id
ContentType string The content type of the
Content-Type attachment
Size integer(int64) The size in bytes of the
attachment
@odata.type string Attachment Type

Name string Attachment name

Name
ContentBytes string(byte) Attachment content
Content

1619 | P a g e
 Office 365 Outlook

ReceiveMessage
Summary:
Description: Receive Email Message

Properties:
Name Type Summary
From string(email) The mailbox owner and
From sender of the message
To string(email) The recipients for the
To message
Cc string(email) The Cc recipients for the
CC message
Bcc string(email) The Bcc recipients for the
BCC message
Subject string The subject of the
Subject message
Body string The body of the message
Body
Importance string The importance of the
Importance message Values: [Low,
Normal, High]
HasAttachment boolean Indicates whether the
Has Attachment message has
attachments
Id string The unique identifier of
Message Id the message
ConversationId string The Id of the
Conversation Id conversation the email
belongs to

1620 | P a g e
 Office 365 Outlook

DateTimeReceived string(date-time) The date and time the

Received Time message was received
IsRead boolean Indicates whether the
Is Read message has been read
Attachments array of The attachments for the
(ReceiveAttachment) message
Attachments
IsHtml boolean Is Html?
Is HTML

1621 | P a g e
 Office 365 Outlook

Recipient
Summary:
Description:

Properties:
Name Type Summary
EmailAddress EmailAddress

1622 | P a g e
 Office 365 Outlook

RecurrencePattern
Summary:
Description:

Properties:
Name Type Summary
Type string Values: [Daily, Weekly,
AbsoluteMonthly,
RelativeMonthly,
AbsoluteYearly,
RelativeYearly]
Interval integer(int32)

Month integer(int32)

DayOfMonth integer(int32)

DaysOfWeek array of (string)

FirstDayOfWeek string Values: [Sunday, Monday,

Tuesday, Wednesday,
Thursday, Friday,
Saturday]
Index string Values: [First, Second,
Third, Fourth, Last]

1623 | P a g e
 Office 365 Outlook

RecurrenceRange
Summary:
Description:

Properties:
Name Type Summary
Type string Values: [EndDate, NoEnd,
Numbered]
StartDate string(date-time)

EndDate string(date-time)

NumberOfOccurrences integer(int32)

1624 | P a g e
 Office 365 Outlook

ResponseStatus
Summary:
Description:

Properties:
Name Type Summary
Response string Values: [None, Organizer,
TentativelyAccepted,
Accepted, Declined,
NotResponded]
Time string(date-time)

1625 | P a g e
 Office 365 Outlook

SendAttachment
Summary:
Description: Attachment

Properties:
Name Type Summary
@odata.type string Attachment Type

Name string Attachment name

Name
ContentBytes string(byte) Attachment content
Content

1626 | P a g e
 Office 365 Outlook

SendMessage
Summary:
Description: Send Email Message

Properties:
Name Type Summary
From string(email) Email address to send
From message from
Cc string(email) Specify email addresses
CC separated by semicolons
like
[email protected]
Bcc string(email) Specify email addresses
BCC separated by semicolons
like
[email protected]
To string(email) Specify email addresses
To separated by semicolons
like
[email protected]
Subject string Specify the subject of the
Subject mail
Body string Specify the body of the mail
Body
Attachments array of (SendAttachment) Attachments
Attachments
Importance string Importance Values: [Low,
Importance Normal, High]
IsHtml boolean Is Html?

1627 | P a g e
 Office 365 Outlook

Is HTML

1628 | P a g e
 Office 365 Outlook

SubscriptionResponse
Summary:
Description: Model for Approval Email Subscription

Properties:
Name Type Summary
id string Id of the subscription

resource string Resource of the

subscription request
notificationType string Notification Type

notificationUrl string Notification Url

1629 | P a g e
 Office 365 Outlook

Table
Summary:
Description:

Properties:
Name Type Summary
Name string

DisplayName string

1630 | P a g e
 Office 365 Outlook

TableCapabilitiesMetadata
Summary:
Description:

Properties:
Name Type Summary
sortRestrictions TableSortRestrictionsMetadata

filterRestrictions TableFilterRestrictionsMetadata

isOnlyServerPagable boolean

filterFunctionSupport array of (string)

1631 | P a g e
 Office 365 Outlook

TableFilterRestrictionsMetadata
Summary:
Description:

Properties:
Name Type Summary
filterable boolean

nonFilterableProperties array of (string)

requiredProperties array of (string)

1632 | P a g e
 Office 365 Outlook

TableMetadata
Summary:
Description:

Properties:
Name Type Summary
name string

title string

x-ms-permission string

x-ms-capabilities TableCapabilitiesMetadata

schema Object

referencedEntities Object

1633 | P a g e
 Office 365 Outlook

TablesList
Summary:
Description:

Properties:
Name Type Summary
value array of (Table)

1634 | P a g e
 Office 365 Outlook

TableSortRestrictionsMetadata
Summary:
Description:

Properties:
Name Type Summary
sortable boolean

unsortableProperties array of (string)

ascendingOnlyProperties array of (string)

1635 | P a g e
 Office 365 Outlook

TabularDataSetsMetadata
Summary:
Description:

Properties:
Name Type Summary
source string

displayName string

urlEncoding string

tableDisplayName string

tablePluralName string

1636 | P a g e
 Office 365 Outlook

TriggerBatchResponse[ReceiveMessage]
Summary:
Description:

Properties:
Name Type Summary
value array of (ReceiveMessage)

1637 | P a g e
 Office 365 Users

Office 365 Users

Office 365 Users Connection provider lets you access user profiles in your
organization using your Office 365 account. You can perform various actions
such as get your profile, a user's profile, a user's manager or direct reports and
also update a user profile.

Status: Production Tier: Standard Version: 1.0

Actions:
Name Summary
MyProfile () Get my profile
UserProfile (string userId) Get user profile
Manager (string userId) Get manager
DirectReports (string userId) Get direct reports
SearchUser ([Optional]string Search for users
searchTerm)

Triggers:
Name Summary

Objects:
Name Summary
User

Actions:
MyProfile
Summary: Get my profile
Description: Retrieves the profile for the current user
1638 | P a g e
 Office 365 Users

Syntax:
Office365Users.MyProfile ()

Returns:
Type:User
Description: User model class.

UserProfile
Summary: Get user profile
Description: Retrieves a specific user profile

Syntax:
Office365Users.UserProfile (string userId)

Parameters:
Name Type Summary Required Related
Action
userId string User principal True
(User) name or email id

Returns:
Type:User
Description: User model class.

Manager
Summary: Get manager
Description: Retrieves user profile for the manager of the specified user

1639 | P a g e
 Office 365 Users

Syntax:
Office365Users.Manager (string userId)

Parameters:
Name Type Summary Required Related
Action
userId string User principal True
(User) name or email id

Returns:
Type:User
Description: User model class.

DirectReports
Summary: Get direct reports
Description: Get direct reports

Syntax:
Office365Users.DirectReports (string userId)

Parameters:
Name Type Summary Required Related
Action
userId string User principal True
(User) name or email id

Returns:
Type:array of (User)

1640 | P a g e
 Office 365 Users

SearchUser
Summary: Search for users
Description: Retrieves search results of user profiles

Syntax:
Office365Users.SearchUser ([Optional]string searchTerm)

Parameters:
Name Type Summary Required Related
Action
searchTerm string Search string False
(Search (applies to:
term) display name,
given name,
surname, mail,
mail nickname
and user
principal name)

Returns:
Type:array of (User)

1641 | P a g e
 Office 365 Users

User
Summary:
Description: User model class.

Properties:
Name Type Summary
Id string User id.
User id
DisplayName string Display name of user.
Display name
GivenName string Given name of user.
Given name
Surname string Surname of user.
Surname
Mail string Email id of user.
Email
MailNickname string Nickname of user.
Nickname
TelephoneNumber string Telephone number of
Telephone number user.
BusinessPhones array of (string) Business Phone numbers
Business Phones of user.
AccountEnabled boolean Account enabled flag.
Account enabled?
UserPrincipalName string User Principal Name.
User Principal Name
Department string Department of the user.
Department
JobTitle string Job Title of the user.

1642 | P a g e
 Office 365 Users

Job title
mobilePhone string User's mobile phone.

1643 | P a g e
 Office 365 Video

Office 365 Video

Video for Office 365 offers a highly scalable, easy-to-use portal for uploading
and sharing your corporate videos

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
IsVideoPortalEnabled (string Checks video portal status
tenant)
ListViewableChannels (string Get all viewable Channels
tenant)
ListVideos (string tenant, Lists all the office365 videos present in a channel
string channelId)
GetVideo (string tenant, string Gets information about a particular office365 video
channelId, string videoId)
GetPlaybackUrl (string tenant, Get playback url of the Azure Media Services
string channelId, string manifest for a video
videoId, string
streamingFormatType)
GetStreamingKeyAccessToken Get the bearer token to get access to decrypt the
(string tenant, string video
channelId, string videoId)

Triggers:
Name Summary

1644 | P a g e
 Office 365 Video

Objects:
Name Summary
Channel
Video

Actions:
IsVideoPortalEnabled
Summary: Checks video portal status
Description: Checks the video portal status to see if video services are enabled

Syntax:
Office365Video.IsVideoPortalEnabled (string tenant)

Parameters:
Name Type Summary Required Related
Action
tenant string The tenant name True
(The tenant for the directory
name for the user is part
the of
directory
the user is
part of)

Returns:
Type:boolean

1645 | P a g e
 Office 365 Video

ListViewableChannels
Summary: Get all viewable Channels
Description: Gets all the channels the user has viewing access to

Syntax:
Office365Video.ListViewableChannels (string tenant)

Parameters:
Name Type Summary Required Related
Action
tenant string The tenant name True
(The tenant for the directory
name for the user is part
the of
directory
the user is
part of)

Returns:
Type:array of (Channel)

ListVideos
Summary: Lists all the office365 videos present in a channel
Description: Lists all the office365 videos present in a channel

Syntax:
Office365Video.ListVideos (string tenant, string channelId)

Parameters:

1646 | P a g e
 Office 365 Video

Name Type Summary Required Related

Action
tenant string The tenant name True
(The tenant for the directory
name for the user is part
the of
directory
the user is
part of)
channelId string The channel id True
(The from which
channel id videos need to
from which be fetched
videos
need to be
fetched)

Returns:
Type:array of (Video)

GetVideo
Summary: Gets information about a particular office365 video
Description: Gets information about a particular office365 video

Syntax:
Office365Video.GetVideo (string tenant, string channelId, string
videoId)

Parameters:

1647 | P a g e
 Office 365 Video

Name Type Summary Required Related

Action
tenant string The tenant name True
(The tenant for the directory
name for the user is part
the of
directory
the user is
part of)
channelId string The channel id True
(The
channel id)
videoId string The video id True
(The video
id)

Returns:
Type:Video
Description: Video class

GetPlaybackUrl
Summary: Get playback url of the Azure Media Services manifest for a video
Description: Get playback url of the Azure Media Services manifest for a video

Syntax:
Office365Video.GetPlaybackUrl (string tenant, string channelId,
string videoId, string streamingFormatType)

Parameters:

1648 | P a g e
 Office 365 Video

Name Type Summary Required Related

Action
tenant string The tenant name True
(The tenant for the directory
name for the user is part
the of
directory
the user is
part of)
channelId string The channel id True
(The
channel id)
videoId string The video id True
(The video
id)
streamingFormatType string Streaming True
(Streaming format type. 1 -
format Smooth
type. 1 - Streaming or
Smooth MPEG-DASH. 0 -
Streaming HLS Streaming
or MPEG-
DASH. 0 -
HLS
Streaming)

Returns:
Type:string

1649 | P a g e
 Office 365 Video

GetStreamingKeyAccessToken
Summary: Get the bearer token to get access to decrypt the video
Description: Get the bearer token to get access to decrypt the video

Syntax:
Office365Video.GetStreamingKeyAccessToken (string tenant, string
channelId, string videoId)

Parameters:
Name Type Summary Required Related
Action
tenant string The tenant name True
(The tenant for the directory
name for the user is part
the of
directory
the user is
part of)
channelId string The channel id True
(The
channel id)
videoId string The video id True
(The video
id)

Returns:
Type:string

1650 | P a g e
 Office 365 Video

Channel
Summary:
Description: Channel class

Properties:
Name Type Summary
Id string Channel Id

Title string Channel title

Description string Channel description

1651 | P a g e
 Office 365 Video

Video
Summary:
Description: Video class

Properties:
Name Type Summary
Id string Video id

Title string video title

Description string video description

CreationDate string creation date of the

video
Owner string video owner

ThumbnailUrl string Thumbnail url

VideoUrl string video url

VideoDuration integer(int64) video duration

VideoProcessingStatus integer(int32) video processing status

ViewCount integer(int64) video view count

1652 | P a g e
 OneNote (Business)

OneNote (Business)
OneNote is a note taking app from Microsoft that makes it easy to sync your
ideas, sketches and notes across all your devices! Connect to your Office 365
account with OneDrive for Business enabled to track new sections, create
notes and more.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
CreatePageInSection (string Create page in a section
notebookKey, string sectionId,
string pageContent)
CreatePageInQuickNotes Create a page in Quick Notes
(string pageContent)
GetNotebooks () Get notebooks
GetSectionsInNotebook Get sections in notebook
(string notebookKey)

Triggers:
Name Summary
OnNewSectionInNotebook When a new section is created
(string notebookKey)
OnNewSectionGroupInNotebook When a new section group is created
(string notebookKey)
OnNewPageInSection (string When a new page is created in a section
notebookKey, string sectionId)

1653 | P a g e
 OneNote (Business)

Objects:
Name Summary
Link
NewPageResponse
NewSectionGroupResponse
NewSectionResponse
Notebook
OneNoteClientUrl
OneNoteWebUrl
Page
ParentNotebook
Section
SectionGroup
SectionListItem

Actions:
CreatePageInSection
Summary: Create page in a section
Description: Create new page in a specified section.

Syntax:
OneNote(Business).CreatePageInSection (string notebookKey,
string sectionId, string pageContent)

Parameters:
Name Type Summary Required Related Action
notebookKey string Notebook True GetNotebooks

1654 | P a g e
 OneNote (Business)

(Notebook
Key)
sectionId string Section True GetSectionsInNotebook
(Section
Id)
pageContent string True

Returns:
Type:Page

CreatePageInQuickNotes
Summary: Create a page in Quick Notes
Description: Create a new page in the Quick Notes section.

Syntax:
OneNote(Business).CreatePageInQuickNotes (string pageContent)

Parameters:
Name Type Summary Required Related
Action
pageContent string True

Returns:
Type:Page

GetNotebooks
Summary: Get notebooks

1655 | P a g e
 OneNote (Business)

Description: Get notebooks

Syntax:
OneNote(Business).GetNotebooks ()

Returns:
Type:array of (Notebook)

GetSectionsInNotebook
Summary: Get sections in notebook
Description: Get sections in notebook

Syntax:
OneNote(Business).GetSectionsInNotebook (string notebookKey)

Parameters:
Name Type Summary Required Related
Action
notebookKey string Notebook True GetNotebooks
(Notebook
Key)

Returns:
Type:array of (SectionListItem)

Triggers:
Trigger OnNewSectionInNotebook
Summary: When a new section is created
Description: Triggers a flow when a new section is added to a notebook.
1656 | P a g e
 OneNote (Business)

Syntax:
OneNote(Business).OnNewSectionInNotebook (string notebookKey)

Parameters:
Name Type Summary Required Related
Action
notebookKey string Notebook True GetNotebooks
(Notebook
Key)

Returns:
Type:NewSectionResponse
Description: Response for a new section

Trigger OnNewSectionGroupInNotebook
Summary: When a new section group is created
Description: Triggers a flow when a new section group is added to a notebook.

Syntax:
OneNote(Business).OnNewSectionGroupInNotebook (string
notebookKey)

Parameters:
Name Type Summary Required Related
Action
notebookKey string Notebook True GetNotebooks
(Notebook
Key)

1657 | P a g e
 OneNote (Business)

Returns:
Type:NewSectionGroupResponse
Description: Response for a new section group

Trigger OnNewPageInSection
Summary: When a new page is created in a section
Description: Triggers a flow when a new page is added to a section.

Syntax:
OneNote(Business).OnNewPageInSection (string notebookKey, string
sectionId)

Parameters:
Name Type Summary Required Related Action
notebookKey string Notebook True GetNotebooks
(Notebook
Key)
sectionId string Section True GetSectionsInNotebook
(Section
Id)

Returns:
Type:NewPageResponse
Description: Response for a new page

1658 | P a g e
 OneNote (Business)

Link
Summary:
Description: Links

Properties:
Name Type Summary
oneNoteClientUrl OneNoteClientUrl OneNote client url

oneNoteWebUrl OneNoteWebUrl OneNote web url

1659 | P a g e
 OneNote (Business)

NewPageResponse
Summary:
Description: Response for a new page

Properties:
Name Type Summary
value array of (Page) An array of objects, each
Pages representing a specific
page

1660 | P a g e
 OneNote (Business)

NewSectionGroupResponse
Summary:
Description: Response for a new section group

Properties:
Name Type Summary
value array of (SectionGroup) An array of objects, each
Section Groups representing a specific
section group

1661 | P a g e
 OneNote (Business)

NewSectionResponse
Summary:
Description: Response for a new section

Properties:
Name Type Summary
value array of (Section) An array of objects, each
Sections representing a specific
section

1662 | P a g e
 OneNote (Business)

Notebook
Summary:
Description: A Notebook

Properties:
Name Type Summary
FileName string

Key string

1663 | P a g e
 OneNote (Business)

OneNoteClientUrl
Summary:
Description: OneNote client url

Properties:
Name Type Summary
href string OneNote client url
OneNote client url

1664 | P a g e
 OneNote (Business)

OneNoteWebUrl
Summary:
Description: OneNote web url

Properties:
Name Type Summary
href string OneNote web url
OneNote web url

1665 | P a g e
 OneNote (Business)

Page
Summary:
Description:

Properties:
Name Type Summary
title string The title of the page.
Title
links Link Links

contentUrl string A url to the page content.

Content Url
lastModifiedTime string(date-time) The last modified date of
Last Modified Date the page.
createdTime string(date-time) The date the page was
Created Date created.
id string The unique identifier of
Id the page.

1666 | P a g e
 OneNote (Business)

ParentNotebook
Summary:
Description:

Properties:
Name Type Summary
id string The unique identifier of
Parent Notebook Key the parent notebook.
name string The name of the parent
Parent Notebook Name notebook.
self string A url link to the parent
Parent Notebook Url notebook.

1667 | P a g e
 OneNote (Business)

Section
Summary:
Description: A section

Properties:
Name Type Summary
createdBy string The creator of the
Creator section.
createdTime string(date-time) The creation date and
Creation Date time of the section.
id string Unique identifier of the
Section Identifier section.
isDefault boolean Indicates whether it is
IsDefault the default section.
lastModifiedBy string The user who last
Last Modified By modified the section.
lastModifiedTime string(date-time) The last modified date
Last Modified Date and time of the section.
name string The name of the section.
Section Name
pagesUrl string Url to the pages in this
Pages Url section.
parentNotebook ParentNotebook

self string The url to this section.

Url

1668 | P a g e
 OneNote (Business)

SectionGroup
Summary:
Description: A section group

Properties:
Name Type Summary
createdTime string(date-time) The creation date and
Creation date time of the section group.
createdBy string The creator of the section
Creator group.
id string Unique identifier of the
Identifier section group.
lastModifiedBy string The user who last
Last modifier modified the section
group.
lastModifiedTime string(date-time) The last modification date
Last modified date and time of the section
group.
name string The name of the section
Name group.
sectionsUrl string Url of the sections within
Sections Url this section group.
self string The url to this section
Section Group Url group

1669 | P a g e
 OneNote (Business)

SectionListItem
Summary:
Description:

Properties:
Name Type Summary
name string The name of the section.
Section name
pagesUrl string The key used to reference
Section key this section; also a url to
the pages.

1670 | P a g e
 Outlook Customer Manager

Outlook Customer Manager

Outlook Customer Manager helps you to graduate from managing contacts to
building relationships. It is part of the Office365 Business Premium
subscription.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
CreateContact Create a business contact
(CreateContactParameterBody
body, [internal]string Content-
Type, [internal]string X-XRM-
Client)
CreateCompany Create a company
(CreateCompanyParameterBody
body, [internal]string Content-
Type, [internal]string X-XRM-
Client)
CreateDeal Create a deal
(CreateDealParameterBody
body, [internal]string Content-
Type, [internal]string X-XRM-
Client)

Triggers:
Name Summary

1671 | P a g e
 Outlook Customer Manager

Objects:
Name Summary
CreateCompanyParameterBody
CreateCompanyResponse
CreateContactParameterBody
CreateContactResponse
CreateDealParameterBody
CreateDealResponse

Actions:
CreateContact
Summary: Create a business contact
Description: This operation is used to create a business contact, that will surface in
Outlook Customer Manager as a business contact.

Syntax:
OutlookCustomerManager.CreateContact (CreateContactParameterBody
body, [internal]string Content-Type, [internal]string X-XRM-
Client)

Parameters:
Name Type Summary Required Related
Action
body CreateContactParameterBody True

Content-Type string True

(Content-Type)
X-XRM-Client string True
(X-XRM-Client)

1672 | P a g e
 Outlook Customer Manager

Returns:
Type:CreateContactResponse

CreateCompany
Summary: Create a company
Description: This operation is used to create a company in Outlook Customer
Manager.

Syntax:
OutlookCustomerManager.CreateCompany (CreateCompanyParameterBody
body, [internal]string Content-Type, [internal]string X-XRM-
Client)

Parameters:
Name Type Summary Required Related
Action
body CreateCompanyParameterBody True

Content-Type string True

(Content-Type)
X-XRM-Client string True
(X-XRM-Client)

Returns:
Type:CreateCompanyResponse

CreateDeal
Summary: Create a deal

1673 | P a g e
 Outlook Customer Manager

Description: This operation is used to create a deal in Outlook Customer Manager, so

you can track your customer opportunities.

Syntax:
OutlookCustomerManager.CreateDeal (CreateDealParameterBody body,
[internal]string Content-Type, [internal]string X-XRM-Client)

Parameters:
Name Type Summary Required Related
Action
body CreateDealParameterBody True

Content-Type string True

(Content-Type)
X-XRM-Client string True
(X-XRM-Client)

Returns:
Type:CreateDealResponse

1674 | P a g e
 Outlook Customer Manager

CreateCompanyParameterBody
Summary:
Description:

Properties:
Name Type Summary
data Data data

contactDisplayName string Linked contact details.

Contact Name
contactEmailAddress string Linked contact details.
Contact Email Address
shouldShare boolean shouldShare
shouldShare

Data
Summary:
Description: data

Properties:
Name Type Summary
displayName string
Company Name
businessHomePage string
Website
emailAddresses array of
(EmailAddressesItem)

businessPhones array of (string)

1675 | P a g e
 Outlook Customer Manager

businessAddress BusinessAddress
Address -
entityType string entityType
entityType

EmailAddressesItem
Summary:
Description:

Properties:
Name Type Summary
address string
Email Address
name string name
name

BusinessAddress
Summary: Address -
Description:

Properties:
Name Type Summary
city string
City
countryOrRegion string
Country or Region
postalCode string
Zip Code

1676 | P a g e
 Outlook Customer Manager

state string
State
street string
Street
type integer(int32) type
type

1677 | P a g e
 Outlook Customer Manager

CreateCompanyResponse
Summary:
Description:

Properties:
Name Type Summary
result Result result

Result
Summary:
Description: result

Properties:
Name Type Summary
displayName string Name of the company.
Company Name
businessHomePage string Company's website.
Website
emailAddresses array of
(EmailAddressesItem)

businessPhones array of (string)

businessAddress BusinessAddress

xrmId string xrmId

xrmId

1678 | P a g e
 Outlook Customer Manager

EmailAddressesItem
Summary:
Description:

Properties:
Name Type Summary
address string Company's email address.
Email Address
name string name
name

BusinessAddress
Summary:
Description:

Properties:
Name Type Summary
city string Business address of the
City company.
countryOrRegion string Business address of the
Country or Region company.
postalCode string Business address of the
Zip Code company.
state string Business address of the
State company.
street string Business address of the
Street company.

1679 | P a g e
 Outlook Customer Manager

CreateContactParameterBody
Summary:
Description:

Properties:
Name Type Summary
data Data data

companyDisplayName string
Company
shouldShare boolean shouldShare
shouldShare

Data
Summary:
Description: data

Properties:
Name Type Summary
givenNames array of (string)

surnames array of (string)

emailAddresses array of
(EmailAddressesItem)

businessPhoneNumbers array of (string)

entityType string entityType

1680 | P a g e
 Outlook Customer Manager

entityType
isBusinessContact boolean isBusinessContact
isBusinessContact

EmailAddressesItem
Summary:
Description:

Properties:
Name Type Summary
address string
Email Address
name string name
name

1681 | P a g e
 Outlook Customer Manager

CreateContactResponse
Summary:
Description:

Properties:
Name Type Summary
result Result result

Result
Summary:
Description: result

Properties:
Name Type Summary
displayName string Business contact's
Name name.
emailAddresses array of
(EmailAddressesItem)

givenNames array of (string)

surnames array of (string)

businessPhoneNumbers array of (string)

xrmIds array of (string)

1682 | P a g e
 Outlook Customer Manager

EmailAddressesItem
Summary:
Description:

Properties:
Name Type Summary
address string Business contact's email.
Email Address
name string name
name

1683 | P a g e
 Outlook Customer Manager

CreateDealParameterBody
Summary:
Description:

Properties:
Name Type Summary
data Data data

contactDisplayName string Details of the linked

Contact Name contact.
contactEmailAddress string Details of the linked
Contact Email contact.
companyDisplayName string Name of the linked
Linked Company company.
shouldShare boolean shouldShare
shouldShare

Data
Summary:
Description: data

Properties:
Name Type Summary
name string
Name
amount integer(int32)
Amount
closeTime string(date-time) MM/DD/YYYY or UTC
Close Date format

1684 | P a g e
 Outlook Customer Manager

entityType string entityType

entityType
priority string Pick a priority. Values:
Priority [Normal, High]
stage string Pick a stage. Values: [In-
Stage progress, Won, Lost,
Invalid]

1685 | P a g e
 Outlook Customer Manager

CreateDealResponse
Summary:
Description:

Properties:
Name Type Summary
result Result result

Result
Summary:
Description: result

Properties:
Name Type Summary
name string Deal's name.
Name
amount number(float) Deal's amount.
Amount
closeTime string(date-time) Deal's close date.
Close Date
priority string Normal or high.
Priority
stage string In-progress, won, lost or
Stage invalid.
company string Related company.
Company
currencyCode string currencyCode
currencyCode

1686 | P a g e
 Outlook Customer Manager

hashtags array of (string) hashtags

status string status

status
xrmId string xrmId
xrmId

1687 | P a g e
 Outlook Tasks

Outlook Tasks
Outlook Tasks service lets you create, read, synchronize, update and delete
your tasks that are secured by Azure Active Directory in Office 365 or a
Microsoft account.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
Internal_GetAllCompletedTasks Get all completed tasks
()
Internal_GetAllIncompleteTasks Get all incomplete tasks
()
GetAllTaskFolders () List all task folders
CreateTaskFolder Create a task folder
([Optional]string groupId,
CreateTaskFolderBody body)
GetTaskGroups () List all task groups
CreateTaskGroup Create a task group
(CreateTaskGroupBody body)
GetTasksByFolder (string List all tasks in folder
groupId, string folderId)
GetAllTasks () List all tasks
CreateTask ([Optional]string Create a task
folderId, CreateTaskBody body)
GetTaskFolders (string groupId) Get task folders in group
CompleteTask (string taskId) Complete a task
GetTask (string taskId) Get task

1688 | P a g e
 Outlook Tasks

IncompleteTask (string taskId, Mark a task as incomplete

IncompleteTaskBody body)

Triggers:
Name Summary
Trigger_OnNewTask When a task is added
([Optional]string folderId)
Trigger_OnCompletedTask When a task is completed
(string taskId)

Objects:
Name Summary
CreateTaskBody
CreateTaskFolderBody
CreateTaskGroupBody
IncompleteTaskBody
Task
TaskFolder
TaskGroup

Actions:
Internal_GetAllCompletedTasks
Summary: Get all completed tasks
Description: Get a list of all of my completed tasks.

Syntax:
OutlookTasks.Internal_GetAllCompletedTasks ()

1689 | P a g e
 Outlook Tasks

Returns:
Type:array of (Task)

Internal_GetAllIncompleteTasks
Summary: Get all incomplete tasks
Description: Get a list of all of my incomplete tasks.

Syntax:
OutlookTasks.Internal_GetAllIncompleteTasks ()

Returns:
Type:array of (Task)

GetAllTaskFolders
Summary: List all task folders
Description: Returns a list of all the task folders in your mailbox.

Syntax:
OutlookTasks.GetAllTaskFolders ()

Returns:
Type:array of (TaskFolder)

CreateTaskFolder
Summary: Create a task folder
Description: Creates a new folder. Optionally, you may choose to put the new folder in
an existing task group.

Syntax:

1690 | P a g e
 Outlook Tasks

OutlookTasks.CreateTaskFolder ([Optional]string groupId,

CreateTaskFolderBody body)

Parameters:
Name Type Summary Required Related Action
groupId string Task group False GetTaskGroups
(Task group)
body CreateTaskFolderBody An Outlook True
Task Folder.

Returns:
Type:TaskFolder
Description: An Outlook task folder.

GetTaskGroups
Summary: List all task groups
Description: Returns a list of all the task groups in your mailbox.

Syntax:
OutlookTasks.GetTaskGroups ()

Returns:
Type:array of (TaskGroup)

CreateTaskGroup
Summary: Create a task group
Description: Creates a new task group in your mailbox.

Syntax:

1691 | P a g e
 Outlook Tasks

OutlookTasks.CreateTaskGroup (CreateTaskGroupBody body)

Parameters:
Name Type Summary Required Related
Action
body CreateTaskGroupBody True

Returns:
Type:TaskGroup

GetTasksByFolder
Summary: List all tasks in folder
Description: Returns a list of all tasks in a given folder.

Syntax:
OutlookTasks.GetTasksByFolder (string groupId, string folderId)

Parameters:
Name Type Summary Required Related Action
groupId string Task group True GetTaskGroups
(Task
group)
folderId string Task folder True GetTaskFolders
(Task
folder)

Returns:
Type:array of (Task)

1692 | P a g e
 Outlook Tasks

GetAllTasks
Summary: List all tasks
Description: Returns a list of all your tasks.

Syntax:
OutlookTasks.GetAllTasks ()

Returns:
Type:array of (Task)

CreateTask
Summary: Create a task
Description: Creates a task in the specified task folder (defaults to My Tasks).

Syntax:
OutlookTasks.CreateTask ([Optional]string folderId,
CreateTaskBody body)

Parameters:
Name Type Summary Required Related Action
folderId string Folder False GetAllTaskFolders
(Folder Id)
body CreateTaskBody An Outlook True
task.

Returns:
Type:Task
Description: An Outlook task.

1693 | P a g e
 Outlook Tasks

GetTaskFolders
Summary: Get task folders in group
Description: Returns a list of task folders in the given task group.

Syntax:
OutlookTasks.GetTaskFolders (string groupId)

Parameters:
Name Type Summary Required Related Action
groupId string Task group True GetTaskGroups
(Task
group)

Returns:
Type:array of (TaskFolder)

CompleteTask
Summary: Complete a task
Description: Marks the given task as complete.

Syntax:
OutlookTasks.CompleteTask (string taskId)

Parameters:
Name Type Summary Required Related Action
taskId string Task Id True Internal_GetAllIncompleteTasks
(Task)

1694 | P a g e
 Outlook Tasks

Returns:
Type:Task
Description: An Outlook task.

GetTask
Summary: Get task
Description: Get details of a task by its id.

Syntax:
OutlookTasks.GetTask (string taskId)

Parameters:
Name Type Summary Required Related
Action
taskId string True
(Task Id)

Returns:
Type:Task
Description: An Outlook task.

IncompleteTask
Summary: Mark a task as incomplete
Description: Marks the given task as incomplete.

Syntax:
OutlookTasks.IncompleteTask (string taskId, IncompleteTaskBody
body)

1695 | P a g e
 Outlook Tasks

Parameters:
Nam Type Summar Require Related Action
e y d
taskI string Task Id True Internal_GetAllCompletedTask
d (Task) s
body IncompleteTaskBod True
y

Returns:
Type:Task
Description: An Outlook task.

Triggers:
Trigger Trigger_OnNewTask
Summary: When a task is added
Description: Triggers when a new task is created.

Syntax:
OutlookTasks.Trigger_OnNewTask ([Optional]string folderId)

Parameters:
Name Type Summary Required Related Action
folderId string Folder False GetAllTaskFolders
(Folder)

Returns:
Type:array of (Task)

1696 | P a g e
 Outlook Tasks

Trigger Trigger_OnCompletedTask
Summary: When a task is completed
Description: Triggers when a task is marked as complete.

Syntax:
OutlookTasks.Trigger_OnCompletedTask (string taskId)

Parameters:
Name Type Summary Required Related Action
taskId string Task Id True Internal_GetAllIncompleteTasks
(Task)

Returns:
Type:Task
Description: An Outlook task.

1697 | P a g e
 Outlook Tasks

CreateTaskBody
Summary:
Description: An Outlook task.

Properties:
Name Type Summary
DueDateTime DueDateTime Date in the UTC time zone
when the task is to be
finished.
ReminderDateTime ReminderDateTime Date-time in UTC time
zone for a reminder alert
of the task to occur.
StartDateTime StartDateTime Date in the UTC time zone
when the task is to begin.
Importance string Low, normal or high.
Values: [Low, Normal,
High]
Subject string Brief description or title of
the task.
Status string Indicates state or progress
of the task - not started,
in progress, completed,
waiting on others or
deferred. Values:
[NotStarted, InProgress,
Completed,
WaitingOnOthers,
Deferred]

1698 | P a g e
 Outlook Tasks

Sensitivity string Indicates the level of

privacy for the event.
Values: [Nomral, Personal,
Private, Confidential]
Body Body Task body that typically
contains information
about the task.
Categories array of (string) Collection of category
names associated with
the task.
IsReminderOn boolean True if an alert is set to
remind the user of the
task.

DueDateTime
Summary:
Description: Date in the UTC time zone when the task is to be finished.

Properties:
Name Type Summary
DateTime string(date-time) YYYY-MM-DD or YYYY-
MM-DDThh:mm:ssZ (note
the time portion will be
ignored)
TimeZone string Time zone of the due date.

ReminderDateTime
Summary:

1699 | P a g e
 Outlook Tasks

Description: Date-time in UTC time zone for a reminder alert of the task to occur.

Properties:
Name Type Summary
DateTime string(date-time) YYYY-MM-DDThh:mm:ssZ
(UTC format)
TimeZone string Time zone of the reminder
date.

StartDateTime
Summary:
Description: Date in the UTC time zone when the task is to begin.

Properties:
Name Type Summary
DateTime string(date-time) YYYY-MM-DD or YYYY-
MM-DDThh:mm:ssZ (note
the time portion will be
ignored)
TimeZone string Time zone of the start
date.

Body
Summary:
Description: Task body that typically contains information about the task.

Properties:
Name Type Summary

1700 | P a g e
 Outlook Tasks

ContentType string Text=0, HTML=1 Values:

[Text, HTML]
Content string The text or HTML content.

1701 | P a g e
 Outlook Tasks

CreateTaskFolderBody
Summary:
Description: An Outlook Task Folder.

Properties:
Name Type Summary
Name string Name of the task folder

1702 | P a g e
 Outlook Tasks

CreateTaskGroupBody
Summary:
Description:

Properties:
Name Type Summary
Name string Group name

1703 | P a g e
 Outlook Tasks

IncompleteTaskBody
Summary:
Description:

Properties:
Name Type Summary
Status string

CompletedDateTime CompletedDateTime Date-time in the UTC

time zone when the task
was finished.

CompletedDateTime
Summary:
Description: Date-time in the UTC time zone when the task was finished.

Properties:
Name Type Summary
DateTime string(date-time) YYYY-MM-DDThh:mm:ssZ
(UTC format)
TimeZone string Time zone of the
completion date.

1704 | P a g e
 Outlook Tasks

Task
Summary:
Description: An Outlook task.

Properties:
Name Type Summary
@odata.context string

@odata.id string

@odata.etag string

Id string Unique identifier of the

task.
CreatedDateTime string(date-time) YYYY-MM-DDThh:mm:ssZ
(UTC format)
LastModifiedDateTime string(date-time) YYYY-MM-DDThh:mm:ssZ
(UTC format)
ChangeKey string

Categories array of (string) Collection of category

names associated with
the task.
AssignedTo string Name of the person who
has been assigned the
task.
Body Body Task body that typically
contains information
about the task.

1705 | P a g e
 Outlook Tasks

CompletedDateTime CompletedDateTime Date-time in the UTC

time zone when the task
was finished.
DueDateTime DueDateTime Date in the UTC time
zone when the task is to
be finished.
Importance string Low, normal or high.
Values: [Low, Normal,
High]
IsReminderOn boolean True if an alert is set to
remind the user of the
task.
Owner string Name of the person who
created the task.
ParentFolderId string

ReminderDateTime ReminderDateTime Date-time in the UTC

time zone for a reminder
alert of the task to occur.
StartDateTime StartDateTime Date in the UTC time
zone when the task is to
begin.
Status string Indicates state or
progress of the task - not
started, in progress,
completed, waiting on
others or deferred.
Values: [NotStarted,
InProgress, Completed,

1706 | P a g e
 Outlook Tasks

WaitingOnOthers,
Deferred]
Subject string Brief description or title
of the task.

Body
Summary:
Description: Task body that typically contains information about the task.

Properties:
Name Type Summary
ContentType string Text=0, HTML=1 Values:
[Text, HTML]
Content string The text or HTML content.

CompletedDateTime
Summary:
Description: Date-time in the UTC time zone when the task was finished.

Properties:
Name Type Summary
DateTime string(date-time) YYYY-MM-DDThh:mm:ssZ
(UTC format)

DueDateTime
Summary:
Description: Date in the UTC time zone when the task is to be finished.

1707 | P a g e
 Outlook Tasks

Properties:
Name Type Summary
DateTime string(date-time) YYYY-MM-DDThh:mm:ssZ
(UTC format)

ReminderDateTime
Summary:
Description: Date-time in the UTC time zone for a reminder alert of the task to occur.

Properties:
Name Type Summary
DateTime string(date-time) YYYY-MM-DDThh:mm:ssZ
(UTC format)

StartDateTime
Summary:
Description: Date in the UTC time zone when the task is to begin.

Properties:
Name Type Summary
DateTime string(date-time) YYYY-MM-DDThh:mm:ssZ
(UTC format)

1708 | P a g e
 Outlook Tasks

TaskFolder
Summary:
Description: An Outlook task folder.

Properties:
Name Type Summary
@odata.id string

Id string Unique identifier of the

task folder.
ChangeKey string

Name string Name of the task folder.

IsDefaultFolder boolean True if this is the default

task folder.
ParentGroupKey string

1709 | P a g e
 Outlook Tasks

TaskGroup
Summary:
Description:

Properties:
Name Type Summary
@odata.id string

Id string

ChangeKey string

IsDefaultGroup boolean True if default task group.

Name string Name of the task group.

GroupKey string

1710 | P a g e
 Outlook.com

Outlook.com
Outlook.com connector allows you to manage your mail, calendars, and
contacts. You can perform various actions such as send mail, schedule
meetings, add contacts, etc.

Status: Production Tier: Standard Version: 1.0

Actions:
Name Summary
GetEmails ([Optional]string Get emails
folderPath, [Optional]integer
top, [Optional]boolean
fetchOnlyUnread,
[Optional]boolean
includeAttachments,
[Optional]string searchQuery,
[internal][Optional]integer skip,
[internal][Optional]string
skipToken)
SendEmail (SendMessage Send an email
emailMessage)
SendDigestMail (DigestMessage Send digest email
digestMessage)
Move (string messageId, string Move email
folderPath)
Flag (string messageId) Flag email
DeleteEmail (string messageId) Delete email
MarkAsRead (string messageId) Mark as read

1711 | P a g e
 Outlook.com

ReplyTo (string messageId, Reply to email

string comment,
[Optional]boolean replyAll)
GetAttachment (string Get attachment
messageId, string attachmentId)
GetRootMailFolders Get root mail folders
([internal][Optional]integer top,
[internal][Optional]integer skip)
GetChildMailFolders (string id, Get child mail folders
[advanced][Optional]integer
top,
[advanced][Optional]integer
skip)
GetDataSetsMetadata ()
ContactGetTable (string table) Get folder metadata
CalendarGetTable (string table) Get calendar metadata
GetTable (string dataset, string
table)
ODataStyleGetTable (string
dataset, string table)
SendMailWithOptions Send email with options
(OptionsEmailSubscription
optionsEmailSubscription)
SendApprovalMail Send approval email
(ApprovalEmailSubscription
approvalEmailSubscription)
DeleteApprovalMailSubscription Delete approval email subscription
(string id)

1712 | P a g e
 Outlook.com

DeleteOptionsMailSubscription Delete options email subscription

(string id)
TestConnection () Tests the connection
CalendarGetTables () Get calendars
ODataStyleGetTables (string Get folders
dataset)
CalendarGetItems (string table, Get events (V1)
[advanced][Optional]string
$filter,
[advanced][Optional]string
$orderby,
[advanced][Optional]integer
$top,
[advanced][Optional]integer
$skip)
CalendarPostItem (string table, Create event (V1)
CalendarEventBackend item)
CalendarGetItem (string table, Get event (V1)
string id)
CalendarDeleteItem (string Delete event
table, string id)
CalendarPatchItem (string table, Update event (V1)
string id, CalendarEventBackend
item)
V2CalendarGetItems (string Get events (V2)
table,
[advanced][Optional]string
$filter,
[advanced][Optional]string

1713 | P a g e
 Outlook.com

$orderby,
[advanced][Optional]integer
$top,
[advanced][Optional]integer
$skip)
V2CalendarPostItem (string Create event (V2)
table, CalendarEventClient
item)
V2CalendarGetItem (string Get event (V2)
table, string id)
V2CalendarPatchItem (string Update event (V2)
table, string id,
CalendarEventClient item)
ContactGetTables () Get contact folders
ContactGetItems (string table, Get contacts
[advanced][Optional]string
$filter,
[advanced][Optional]string
$orderby,
[advanced][Optional]integer
$top,
[advanced][Optional]integer
$skip)
ContactPostItem (string table, Create contact
Contact item)
ContactGetItem (string table, Get contact
string id)
ContactDeleteItem (string table, Delete contact
string id)

1714 | P a g e
 Outlook.com

ContactPatchItem (string table, Update contact

string id, Contact item)
GetDataSets () Get datasets
ReceiveResponseGet (string Receives response from user
state)
ReceiveResponsePost (string Receives response from user
state)

Triggers:
Name Summary
OnUpcomingEvents (string table, When an upcoming event is starting soon
[advanced][Optional]integer
lookAheadTimeInMinutes)
OnNewEmail ([Optional]string When a new email arrives
folderPath, [advanced][Optional]string
to, [advanced][Optional]string from,
[advanced][Optional]string importance,
[advanced][Optional]boolean
fetchOnlyWithAttachment,
[advanced][Optional]boolean
includeAttachments,
[advanced][Optional]string subjectFilter)
OnFlaggedEmail ([Optional]string When an email is flagged
folderPath, [advanced][Optional]string
to, [advanced][Optional]string from,
[advanced][Optional]string importance,
[advanced][Optional]boolean
fetchOnlyWithAttachment,

1715 | P a g e
 Outlook.com

[advanced][Optional]boolean
includeAttachments,
[advanced][Optional]string subjectFilter)
CalendarGetOnNewItems (string table, When a new event is created (V1)
[advanced][Optional]string $filter,
[advanced][Optional]string $orderby,
[advanced][Optional]integer $top,
[advanced][Optional]integer $skip)
CalendarGetOnUpdatedItems (string When an event is modified (V1)
table, [advanced][Optional]string $filter,
[advanced][Optional]string $orderby,
[advanced][Optional]integer $top,
[advanced][Optional]integer $skip)
ODataStyleGetOnNewItems (string When a new item is created in a table
dataset, string table,
[advanced][Optional]string $filter,
[advanced][Optional]string $orderby,
[advanced][Optional]integer $top,
[advanced][Optional]integer $skip)
ODataStyleCalendarGetOnUpdatedItems When an item is modified
(string dataset, string table,
[advanced][Optional]string $filter,
[advanced][Optional]string $orderby,
[advanced][Optional]integer $top,
[advanced][Optional]integer $skip)
V2CalendarGetOnNewItems (string When a new event is created (V2)
table, [advanced][Optional]string $filter,
[advanced][Optional]string $orderby,

1716 | P a g e
 Outlook.com

[advanced][Optional]integer $top,
[advanced][Optional]integer $skip)
V2CalendarGetOnUpdatedItems (string When an event is modified (V2)
table, [advanced][Optional]string $filter,
[advanced][Optional]string $orderby,
[advanced][Optional]integer $top,
[advanced][Optional]integer $skip)
GetOnDeletedItems (string dataset,
string table, [advanced][Optional]string
$filter, [advanced][Optional]string
$orderby, [advanced][Optional]integer
$top, [advanced][Optional]integer $skip)
ODataStyleGetOnDeletedItems (string
dataset, string table,
[advanced][Optional]string $filter,
[advanced][Optional]string $orderby,
[advanced][Optional]integer $top,
[advanced][Optional]integer $skip)

Objects:
Name Summary
ApprovalEmailSubscription
ApprovalMessage
Attendee
BlobDataSetsMetadata
CalendarEventBackend
CalendarEventClient
CalendarEventClientReceive

1717 | P a g e
 Outlook.com

CalendarEventList
CalendarEventListClientReceive
Contact
ContactList
DataSet
DataSetsList
DataSetsMetadata
DigestMessage
EmailAddress
FilePickerFolder
GeoCoordinates
Item
ItemBody
ItemsList
Location
MessageWithOptions
Object
OptionsEmailSubscription
PageListResponse[FilePickerFolder]
PatternedRecurrence
PhysicalAddress
ReceiveAttachment
ReceiveMessage
Recipient
RecurrencePattern
RecurrenceRange
ResponseStatus
SendAttachment

1718 | P a g e
 Outlook.com

SendMessage
SubscriptionResponse
Table
TableCapabilitiesMetadata
TableFilterRestrictionsMetadata
TableMetadata
TablesList
TableSortRestrictionsMetadata
TabularDataSetsMetadata
TriggerBatchResponse[ReceiveMessage]

Actions:
GetEmails
Summary: Get emails
Description: This operation gets emails from a folder.

Syntax:
Outlook.com.GetEmails ([Optional]string folderPath,
[Optional]integer top, [Optional]boolean fetchOnlyUnread,
[Optional]boolean includeAttachments, [Optional]string
searchQuery, [internal][Optional]integer skip,
[internal][Optional]string skipToken)

Parameters:
Name Type Summary Required Related
Action
folderPath string Mail folder to False
(Folder) retrieve emails

1719 | P a g e
 Outlook.com

from (default:
'Inbox')
top integer(int32) Number of False
(Top) emails to
retrieve
(default: 10)
fetchOnlyUnread boolean Retrieve only False
(Fetch Only unread emails?
Unread
Messages)
includeAttachments boolean If set to true, False
(Include attachments will
Attachments) also be
retrieved along
with the email
searchQuery string Search query to False
(Search filter emails
Query)
skip integer(int32) Number of False
(Skip) emails to skip
(default: 0)
skipToken string Skip token to False
(Skip Token) fetch new page

Returns:
Type:array of (ReceiveMessage)

SendEmail
Summary: Send an email

1720 | P a g e
 Outlook.com

Description: This operation sends an email message.

Syntax:
Outlook.com.SendEmail (SendMessage emailMessage)

Parameters:
Name Type Summary Required Related
Action
emailMessage SendMessage Send Email True
Message

Returns:

SendDigestMail
Summary: Send digest email
Description: This operation sends a digest email.

Syntax:
Outlook.com.SendDigestMail (DigestMessage digestMessage)

Parameters:
Name Type Summary Required Related
Action
digestMessage DigestMessage Send Email True
Message

Returns:

1721 | P a g e
 Outlook.com

Move
Summary: Move email
Description: This operation moves an email to the specified folder.

Syntax:
Outlook.com.Move (string messageId, string folderPath)

Parameters:
Name Type Summary Required Related
Action
messageId string Id of the email to True
(Message be moved
Id)
folderPath string Mail folder to True
(Folder) move the email
to

Returns:

Flag
Summary: Flag email
Description: This operation flags an email.

Syntax:
Outlook.com.Flag (string messageId)

Parameters:

1722 | P a g e
 Outlook.com

Name Type Summary Required Related

Action
messageId string Id of the email to True
(Message be flagged
Id)

Returns:

DeleteEmail
Summary: Delete email
Description: This operation deletes an email by id.

Syntax:
Outlook.com.DeleteEmail (string messageId)

Parameters:
Name Type Summary Required Related
Action
messageId string Id of the email to True
(Message delete
Id)

Returns:

MarkAsRead
Summary: Mark as read
Description: This operation marks an email as having been read.

Syntax:

1723 | P a g e
 Outlook.com

Outlook.com.MarkAsRead (string messageId)

Parameters:
Name Type Summary Required Related
Action
messageId string Id of the email to True
(Message be marked as
Id) read

Returns:

ReplyTo
Summary: Reply to email
Description: This operation replies to an email.

Syntax:
Outlook.com.ReplyTo (string messageId, string comment,
[Optional]boolean replyAll)

Parameters:
Name Type Summary Required Related
Action
messageId string Id of the email to True
(Message reply to
Id)
comment string Reply comment True
(Comment)
replyAll boolean Reply to all False
(Reply All) recipients

1724 | P a g e
 Outlook.com

Returns:

GetAttachment
Summary: Get attachment
Description: This operation gets an email attachment by id.

Syntax:
Outlook.com.GetAttachment (string messageId, string
attachmentId)

Parameters:
Name Type Summary Required Related
Action
messageId string Id of the email True
(Message
Id)
attachmentId string Id of the True
(Attachment attachment to
Id) download

Returns:
Type:string(binary)

GetRootMailFolders
Summary: Get root mail folders
Description: Get root mail folders

Syntax:

1725 | P a g e
 Outlook.com

Outlook.com.GetRootMailFolders ([internal][Optional]integer top,

[internal][Optional]integer skip)

Parameters:
Name Type Summary Required Related
Action
top integer(int64) Limit on the False
(Top) number of
results to return
skip integer(int64) Number of False
(Skip) results to skip

Returns:
Type:PageListResponse[FilePickerFolder]
Description: Response containing a list and next link

GetChildMailFolders
Summary: Get child mail folders
Description: Get child mail folders

Syntax:
Outlook.com.GetChildMailFolders (string id,
[advanced][Optional]integer top, [advanced][Optional]integer
skip)

Parameters:
Name Type Summary Required Related
Action

1726 | P a g e
 Outlook.com

id string Id of the parent True

(Folder Id) folder
top integer(int64) Limit on the False
(Top) number of
results to return
skip integer(int64) Number of False
(Skip) results to skip

Returns:
Type:PageListResponse[FilePickerFolder]
Description: Response containing a list and next link

GetDataSetsMetadata
Summary:
Description:

Syntax:
Outlook.com.GetDataSetsMetadata ()

Returns:
Type:DataSetsMetadata

ContactGetTable
Summary: Get folder metadata
Description: This operation gets metadata for a contacts folder.

Syntax:
Outlook.com.ContactGetTable (string table)

1727 | P a g e
 Outlook.com

Parameters:
Name Type Summary Required Related Action
table string Select a True ContactGetTables
(Folder id) contacts folder

Returns:
Type:TableMetadata

CalendarGetTable
Summary: Get calendar metadata
Description: This operation gets metadata for a calendar

Syntax:
Outlook.com.CalendarGetTable (string table)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Folder id) calendar

Returns:
Type:TableMetadata

GetTable
Summary:
Description:

Syntax:
Outlook.com.GetTable (string dataset, string table)

1728 | P a g e
 Outlook.com

Parameters:
Name Type Summary Required Related
Action
dataset string True GetDataSets

table string True

Returns:
Type:TableMetadata

ODataStyleGetTable
Summary:
Description:

Syntax:
Outlook.com.ODataStyleGetTable (string dataset, string table)

Parameters:
Name Type Summary Required Related
Action
dataset string True

table string True

Returns:
Type:TableMetadata

1729 | P a g e
 Outlook.com

SendMailWithOptions
Summary: Send email with options
Description: This operation sends an email with multiple options and waits for the
recipient to respond back with one of the options.

Syntax:
Outlook.com.SendMailWithOptions (OptionsEmailSubscription
optionsEmailSubscription)

Parameters:
Name Type Summary Require Relate
d d
Action
optionsEmailSubscripti OptionsEmailSubscripti Model for True
on on Options
Email
Subscriptio
n

Returns:
Type:SubscriptionResponse
Description: Model for Approval Email Subscription

SendApprovalMail
Summary: Send approval email
Description: This operation sends an approval email and waits for a response from the
recipient.

1730 | P a g e
 Outlook.com

Syntax:
Outlook.com.SendApprovalMail (ApprovalEmailSubscription
approvalEmailSubscription)

Parameters:
Name Type Summary Require Relate
d d
Action
approvalEmailSubscripti ApprovalEmailSubscripti Model for True
on on Approval
Email
Subscriptio
n

Returns:
Type:SubscriptionResponse
Description: Model for Approval Email Subscription

DeleteApprovalMailSubscription
Summary: Delete approval email subscription
Description: This operation deletes a subscription of approval email.

Syntax:
Outlook.com.DeleteApprovalMailSubscription (string id)

Parameters:
Name Type Summary Required Related
Action

1731 | P a g e
 Outlook.com

id string Id of subscription True

(Id of to be deleted
subscription
to be
deleted)

Returns:

DeleteOptionsMailSubscription
Summary: Delete options email subscription
Description: This operation deletes a subscription of options email

Syntax:
Outlook.com.DeleteOptionsMailSubscription (string id)

Parameters:
Name Type Summary Required Related
Action
id string Id of subscription True
(Id of to be deleted
subscription
to be
deleted)

Returns:

TestConnection
Summary: Tests the connection
Description: Tests the connection

1732 | P a g e
 Outlook.com

Syntax:
Outlook.com.TestConnection ()

Returns:

CalendarGetTables
Summary: Get calendars
Description: This operation lists available calendars.

Syntax:
Outlook.com.CalendarGetTables ()

Returns:
Type:TablesList

ODataStyleGetTables
Summary: Get folders
Description: This operation lists available contact folders.

Syntax:
Outlook.com.ODataStyleGetTables (string dataset)

Parameters:
Name Type Summary Required Related
Action
dataset string dataset name True
(Dataset)

1733 | P a g e
 Outlook.com

Returns:
Type:TablesList

CalendarGetItems
Summary: Get events (V1)
Description: This operation gets events from a calendar. (V1)

Syntax:
Outlook.com.CalendarGetItems (string table,
[advanced][Optional]string $filter, [advanced][Optional]string
$orderby, [advanced][Optional]integer $top,
[advanced][Optional]integer $skip)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar id) calendar
$filter string An ODATA False
(Filter Query) filter query to
restrict the
entries
returned
$orderby string An ODATA False
(Order By) orderBy
query for
specifying the
order of
entries

1734 | P a g e
 Outlook.com

$top integer(int32) Total number False

(Top Count) of entries to
retrieve
(default = all)
$skip integer(int32) Number of False
(Skip Count) entries to skip
(default = 0)

Returns:
Type:CalendarEventList
Description: The list of calendar items

CalendarPostItem
Summary: Create event (V1)
Description: This operation creates a new event in a calendar. (V1)

Syntax:
Outlook.com.CalendarPostItem (string table, CalendarEventBackend
item)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar id) calendar
item CalendarEventBackend Connector True
specific
calendar
event
model class

1735 | P a g e
 Outlook.com

for the
backend

Returns:
Type:CalendarEventBackend
Description: Connector specific calendar event model class for the backend

CalendarGetItem
Summary: Get event (V1)
Description: This operation gets a specific event from a calendar. (V1)

Syntax:
Outlook.com.CalendarGetItem (string table, string id)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar calendar
id)
id string Select an True
(Item id) event

Returns:
Type:CalendarEventBackend
Description: Connector specific calendar event model class for the backend

CalendarDeleteItem
Summary: Delete event
Description: This operation deletes an event in a calendar.

1736 | P a g e
 Outlook.com

Syntax:
Outlook.com.CalendarDeleteItem (string table, string id)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar calendar
id)
id string Select an True
(Id) event

Returns:

CalendarPatchItem
Summary: Update event (V1)
Description: This operation updates an event in a calendar. (V1)

Syntax:
Outlook.com.CalendarPatchItem (string table, string id,
CalendarEventBackend item)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar id) calendar
id string Select an True
(Id) event

1737 | P a g e
 Outlook.com

item CalendarEventBackend Connector True

specific
calendar
event
model class
for the
backend

Returns:
Type:CalendarEventBackend
Description: Connector specific calendar event model class for the backend

V2CalendarGetItems
Summary: Get events (V2)
Description: This operation gets events from a calendar. (V2)

Syntax:
Outlook.com.V2CalendarGetItems (string table,
[advanced][Optional]string $filter, [advanced][Optional]string
$orderby, [advanced][Optional]integer $top,
[advanced][Optional]integer $skip)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar id) calendar
$filter string An ODATA False
(Filter Query) filter query to
restrict the

1738 | P a g e
 Outlook.com

entries
returned
$orderby string An ODATA False
(Order By) orderBy
query for
specifying the
order of
entries
$top integer(int32) Total number False
(Top Count) of entries to
retrieve
(default = all)
$skip integer(int32) Number of False
(Skip Count) entries to skip
(default = 0)

Returns:
Type:CalendarEventListClientReceive
Description: The list of calendar items

V2CalendarPostItem
Summary: Create event (V2)
Description: This operation creates a new event in a calendar. (V2)

Syntax:
Outlook.com.V2CalendarPostItem (string table,
CalendarEventClient item)

Parameters:

1739 | P a g e
 Outlook.com

Name Type Summary Required Related Action

table string Select a True CalendarGetTables
(Calendar id) calendar
item CalendarEventClient Connector True
specific
calendar
event model
class for the
client

Returns:
Type:CalendarEventClientReceive
Description: Connector specific calendar event model class for the client

V2CalendarGetItem
Summary: Get event (V2)
Description: This operation gets a specific event from a calendar. (V2)

Syntax:
Outlook.com.V2CalendarGetItem (string table, string id)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar calendar
id)
id string Select an True
(Item id) event

1740 | P a g e
 Outlook.com

Returns:
Type:CalendarEventClientReceive
Description: Connector specific calendar event model class for the client

V2CalendarPatchItem
Summary: Update event (V2)
Description: This operation updates an event in a calendar. (V2)

Syntax:
Outlook.com.V2CalendarPatchItem (string table, string id,
CalendarEventClient item)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar id) calendar
id string Select an True
(Id) event
item CalendarEventClient Connector True
specific
calendar
event model
class for the
client

Returns:
Type:CalendarEventClientReceive
Description: Connector specific calendar event model class for the client

1741 | P a g e
 Outlook.com

ContactGetTables
Summary: Get contact folders
Description: This operation lists available contacts folders.

Syntax:
Outlook.com.ContactGetTables ()

Returns:
Type:TablesList

ContactGetItems
Summary: Get contacts
Description: This operation gets contacts from a contacts folder.

Syntax:
Outlook.com.ContactGetItems (string table,
[advanced][Optional]string $filter, [advanced][Optional]string
$orderby, [advanced][Optional]integer $top,
[advanced][Optional]integer $skip)

Parameters:
Name Type Summary Required Related Action
table string Unique True ContactGetTables
(Folder id) identifier of
the contacts
folder to
retrieve
$filter string An ODATA False
(Filter Query) filter query to

1742 | P a g e
 Outlook.com

restrict the
entries
returned
$orderby string An ODATA False
(Order By) orderBy query
for specifying
the order of
entries
$top integer(int32) Total number False
(Top Count) of entries to
retrieve
(default = all)
$skip integer(int32) Number of False
(Skip Count) entries to skip
(default = 0)

Returns:
Type:ContactList
Description: The list of contacts

ContactPostItem
Summary: Create contact
Description: This operation creates a new contact in a contacts folder.

Syntax:
Outlook.com.ContactPostItem (string table, Contact item)

Parameters:
Name Type Summary Required Related Action

1743 | P a g e
 Outlook.com

table string Select a True ContactGetTables

(Folder id) contacts folder
item Contact Contact True

Returns:
Type:Contact
Description: Contact

ContactGetItem
Summary: Get contact
Description: This operation gets a specific contact from a contacts folder.

Syntax:
Outlook.com.ContactGetItem (string table, string id)

Parameters:
Name Type Summary Required Related Action
table string Select a True ContactGetTables
(Folder id) contacts folder
id string Unique True
(Item id) identifier of a
contact to
retrieve

Returns:
Type:Contact
Description: Contact

1744 | P a g e
 Outlook.com

ContactDeleteItem
Summary: Delete contact
Description: This operation deletes a contact from a contacts folder.

Syntax:
Outlook.com.ContactDeleteItem (string table, string id)

Parameters:
Name Type Summary Required Related Action
table string Select a True ContactGetTables
(Folder id) contacts folder
id string Unique True
(Id) identifier of
contact to
delete

Returns:

ContactPatchItem
Summary: Update contact
Description: This operation updates a contact in a contacts folder.

Syntax:
Outlook.com.ContactPatchItem (string table, string id, Contact
item)

Parameters:
Name Type Summary Required Related Action

1745 | P a g e
 Outlook.com

table string Select a True ContactGetTables

(Folder id) contacts folder
id string Unique True
(Id) identifier of
contact to
update
item Contact Contact True

Returns:
Type:Contact
Description: Contact

GetDataSets
Summary: Get datasets
Description: This operation gets Contacts or Calendars

Syntax:
Outlook.com.GetDataSets ()

Returns:
Type:DataSetsList

ReceiveResponseGet
Summary: Receives response from user
Description: This operation gets a response from the user.

Syntax:
Outlook.com.ReceiveResponseGet (string state)

1746 | P a g e
 Outlook.com

Parameters:
Name Type Summary Required Related
Action
state string callback state True
(callback
state)

Returns:
Type:string

ReceiveResponsePost
Summary: Receives response from user
Description: This operation gets a response from the user.

Syntax:
Outlook.com.ReceiveResponsePost (string state)

Parameters:
Name Type Summary Required Related
Action
state string callback state True
(callback
state)

Returns:
Type:string

1747 | P a g e
 Outlook.com

Triggers:
Trigger OnUpcomingEvents
Summary: When an upcoming event is starting soon
Description: This operation triggers a flow when an upcoming calendar event is
starting.

Syntax:
Outlook.com.OnUpcomingEvents (string table,
[advanced][Optional]integer lookAheadTimeInMinutes)

Parameters:
Name Type Summary Require Related Action
d
table string Unique True CalendarGetTable
(Calendar id) identifier s
of the
calendar
lookAheadTimeInMinute integer(int32 Time (in False
s ) minutes)
(Look ahead to look
time) ahead for
upcomin
g events

Returns:
Type:CalendarEventList
Description: The list of calendar items

1748 | P a g e
 Outlook.com

Trigger OnNewEmail
Summary: When a new email arrives
Description: This operation triggers a flow when a new email arrives

Syntax:
Outlook.com.OnNewEmail ([Optional]string folderPath,
[advanced][Optional]string to, [advanced][Optional]string from,
[advanced][Optional]string importance,
[advanced][Optional]boolean fetchOnlyWithAttachment,
[advanced][Optional]boolean includeAttachments,
[advanced][Optional]string subjectFilter)

Parameters:
Name Type Summary Require Relate
d d
Action
folderPath string Mail folder False
(Folder) to retrieve
from
(default:
Inbox)
to string(email) Recipient False
(To) email
addresses
(If any of
the
addresses
match, the
trigger will
run)

1749 | P a g e
 Outlook.com

from string(email) From False

(From) address
importance string Importance False
(Importance)Values of the email
: [Any, Low, (Any, High,
Normal, High] Normal,
Low)
(default:
Any)
fetchOnlyWithAttachmen boolean Retrieve False
t (Has Attachment) only emails
with an
attachment
includeAttachments boolean Include False
(Include attachment
Attachments) s
subjectFilter string String to False
(Subject Filter) look for in
the subject

Returns:
Type:TriggerBatchResponse[ReceiveMessage]

Trigger OnFlaggedEmail
Summary: When an email is flagged
Description: This operation triggers a flow when an email is flagged

Syntax:

1750 | P a g e
 Outlook.com

Outlook.com.OnFlaggedEmail ([Optional]string folderPath,

[advanced][Optional]string to, [advanced][Optional]string from,
[advanced][Optional]string importance,
[advanced][Optional]boolean fetchOnlyWithAttachment,
[advanced][Optional]boolean includeAttachments,
[advanced][Optional]string subjectFilter)

Parameters:
Name Type Summary Require Relate
d d
Action
folderPath string Mail folder False
(Folder) to retrieve
from
(default:
Inbox)
to string(email) Recipient False
(To) email
addresses
(If any of
the
addresses
match, the
trigger will
run)
from string(email) From False
(From) address
importance string Importance False
of the email
(Any, High,

1751 | P a g e
 Outlook.com

(Importance)Values Normal,
: [Any, Low, Low)
Normal, High] (default:
Any)
fetchOnlyWithAttachmen boolean Retrieve False
t (Has Attachment) only emails
with an
attachment
includeAttachments boolean Include False
(Include attachment
Attachments) s
subjectFilter string String to False
(Subject Filter) look for in
the subject

Returns:
Type:TriggerBatchResponse[ReceiveMessage]

Trigger CalendarGetOnNewItems
Summary: When a new event is created (V1)
Description: This operation triggers a flow when a new event is created in a calendar.
(V1)

Syntax:
Outlook.com.CalendarGetOnNewItems (string table,
[advanced][Optional]string $filter, [advanced][Optional]string
$orderby, [advanced][Optional]integer $top,
[advanced][Optional]integer $skip)

Parameters:

1752 | P a g e
 Outlook.com

Name Type Summary Required Related Action

table string Select a True CalendarGetTables
(Calendar id) calendar
$filter string An ODATA False
(Filter Query) filter query to
restrict the
entries
returned
$orderby string An ODATA False
(Order By) orderBy
query for
specifying the
order of
entries
$top integer(int32) Total number False
(Top Count) of entries to
retrieve
(default = all)
$skip integer(int32) Number of False
(Skip Count) entries to skip
(default = 0)

Returns:
Type:CalendarEventList
Description: The list of calendar items

Trigger CalendarGetOnUpdatedItems
Summary: When an event is modified (V1)

1753 | P a g e
 Outlook.com

Description: This operation triggers a flow when an event is modified in a calendar.

(V1)

Syntax:
Outlook.com.CalendarGetOnUpdatedItems (string table,
[advanced][Optional]string $filter, [advanced][Optional]string
$orderby, [advanced][Optional]integer $top,
[advanced][Optional]integer $skip)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar id) calendar
$filter string An ODATA False
(Filter Query) filter query to
restrict the
entries
returned
$orderby string An ODATA False
(Order By) orderBy
query for
specifying the
order of
entries
$top integer(int32) Total number False
(Top Count) of entries to
retrieve
(default = all)

1754 | P a g e
 Outlook.com

$skip integer(int32) Number of False

(Skip Count) entries to skip
(default = 0)

Returns:
Type:CalendarEventList
Description: The list of calendar items

Trigger ODataStyleGetOnNewItems
Summary: When a new item is created in a table
Description: This operation triggers a flow when a new item is created in a table.

Syntax:
Outlook.com.ODataStyleGetOnNewItems (string dataset, string
table, [advanced][Optional]string $filter,
[advanced][Optional]string $orderby, [advanced][Optional]integer
$top, [advanced][Optional]integer $skip)

Parameters:
Name Type Summary Required Related
Action
dataset string dataset name True
(Dataset)
table string table name True
(Calendar id)
$filter string An ODATA filter False
(Filter Query) query to restrict
the entries
returned

1755 | P a g e
 Outlook.com

$orderby string An ODATA False

(Order By) orderBy query
for specifying
the order of
entries
$top integer(int32) Total number of False
(Top Count) entries to
retrieve (default
= all)
$skip integer(int32) Number of False
(Skip Count) entries to skip
(default = 0)

Returns:
Type:CalendarEventList
Description: The list of calendar items

Trigger ODataStyleCalendarGetOnUpdatedItems
Summary: When an item is modified
Description: This operation triggers a flow when an item is modified in a table.

Syntax:
Outlook.com.ODataStyleCalendarGetOnUpdatedItems (string dataset,
string table, [advanced][Optional]string $filter,
[advanced][Optional]string $orderby, [advanced][Optional]integer
$top, [advanced][Optional]integer $skip)

Parameters:

1756 | P a g e
 Outlook.com

Name Type Summary Required Related

Action
dataset string dataset name True
(Dataset)
table string table name True
(Calendar id)
$filter string An ODATA filter False
(Filter Query) query to restrict
the entries
returned
$orderby string An ODATA False
(Order By) orderBy query
for specifying
the order of
entries
$top integer(int32) Total number of False
(Top Count) entries to
retrieve (default
= all)
$skip integer(int32) Number of False
(Skip Count) entries to skip
(default = 0)

Returns:
Type:CalendarEventList
Description: The list of calendar items

Trigger V2CalendarGetOnNewItems
Summary: When a new event is created (V2)

1757 | P a g e
 Outlook.com

Description: This operation triggers a flow when a new event is created in a calendar.
(V2)

Syntax:
Outlook.com.V2CalendarGetOnNewItems (string table,
[advanced][Optional]string $filter, [advanced][Optional]string
$orderby, [advanced][Optional]integer $top,
[advanced][Optional]integer $skip)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar id) calendar
$filter string An ODATA False
(Filter Query) filter query to
restrict the
entries
returned
$orderby string An ODATA False
(Order By) orderBy
query for
specifying the
order of
entries
$top integer(int32) Total number False
(Top Count) of entries to
retrieve
(default = all)

1758 | P a g e
 Outlook.com

$skip integer(int32) Number of False

(Skip Count) entries to skip
(default = 0)

Returns:
Type:CalendarEventListClientReceive
Description: The list of calendar items

Trigger V2CalendarGetOnUpdatedItems
Summary: When an event is modified (V2)
Description: This operation triggers a flow when an event is modified in a calendar.
(V2)

Syntax:
Outlook.com.V2CalendarGetOnUpdatedItems (string table,
[advanced][Optional]string $filter, [advanced][Optional]string
$orderby, [advanced][Optional]integer $top,
[advanced][Optional]integer $skip)

Parameters:
Name Type Summary Required Related Action
table string Select a True CalendarGetTables
(Calendar id) calendar
$filter string An ODATA False
(Filter Query) filter query to
restrict the
entries
returned

1759 | P a g e
 Outlook.com

$orderby string An ODATA False

(Order By) orderBy
query for
specifying the
order of
entries
$top integer(int32) Total number False
(Top Count) of entries to
retrieve
(default = all)
$skip integer(int32) Number of False
(Skip Count) entries to skip
(default = 0)

Returns:
Type:CalendarEventListClientReceive
Description: The list of calendar items

Trigger GetOnDeletedItems
Summary:
Description:

Syntax:
Outlook.com.GetOnDeletedItems (string dataset, string table,
[advanced][Optional]string $filter, [advanced][Optional]string
$orderby, [advanced][Optional]integer $top,
[advanced][Optional]integer $skip)

Parameters:

1760 | P a g e
 Outlook.com

Name Type Summary Required Related

Action
dataset string True GetDataSets

table string True

$filter string An ODATA filter False

(Filter Query) query to
restrict the
entries
returned
$orderby string An ODATA False
(Order By) orderBy query
for specifying
the order of
entries
$top integer(int32) Total number False
(Top Count) of entries to
retrieve
(default = all)
$skip integer(int32) Number of False
(Skip Count) entries to skip
(default = 0)

Returns:
Type:ItemsList

Trigger ODataStyleGetOnDeletedItems
Summary:

1761 | P a g e
 Outlook.com

Description:

Syntax:
Outlook.com.ODataStyleGetOnDeletedItems (string dataset, string
table, [advanced][Optional]string $filter,
[advanced][Optional]string $orderby, [advanced][Optional]integer
$top, [advanced][Optional]integer $skip)

Parameters:
Name Type Summary Required Related
Action
dataset string True

table string True

$filter string An ODATA filter False

(Filter Query) query to restrict
the entries
returned
$orderby string An ODATA False
(Order By) orderBy query
for specifying
the order of
entries
$top integer(int32) Total number of False
(Top Count) entries to
retrieve (default
= all)

1762 | P a g e
 Outlook.com

$skip integer(int32) Number of False

(Skip Count) entries to skip
(default = 0)

Returns:
Type:ItemsList

1763 | P a g e
 Outlook.com

ApprovalEmailSubscription
Summary:
Description: Model for Approval Email Subscription

Properties:
Name Type Summary
NotificationUrl string Gets or sets callback url
to flow engine. It is
expected as part of
request
Message ApprovalMessage Approval Email Message.
This is the message
expected as part of user
input

1764 | P a g e
 Outlook.com

ApprovalMessage
Summary:
Description: Approval Email Message. This is the message expected as part of user
input

Properties:
Name Type Summary
To string(email) Specify email addresses
To separated by semicolons
like
[email protected]
Subject string Subject
Subject
Options string User Options
User Options
Body string Body
Body
Importance string Importance Values: [Low,
Importance Normal, High]
Attachments array of (SendAttachment) Attachments
Attachments

1765 | P a g e
 Outlook.com

Attendee
Summary:
Description:

Properties:
Name Type Summary
Status ResponseStatus

Type string Values: [Required,

Optional, Resource]
EmailAddress EmailAddress

1766 | P a g e
 Outlook.com

BlobDataSetsMetadata
Summary:
Description:

Properties:
Name Type Summary
source string

displayName string

urlEncoding string

1767 | P a g e
 Outlook.com

CalendarEventBackend
Summary:
Description: Connector specific calendar event model class for the backend

Properties:
Name Type Summary
Id string The Event's unique
Id identifier
Attendees array of (Attendee) List of attendees for the
Attendees event
Body ItemBody

BodyPreview string The preview of the

Body preview message associated with
the event
Categories array of (string) The categories associated
Categories with the event
ChangeKey string This property identifies
Change key the version of the event
object. Every time the
event is changed,
ChangeKey changes as
well.
DateTimeCreated string(date-time) The date and time that
Created time the event was created
DateTimeLastModified string(date-time) The date and time that
Last modified time the event was last
modified
End string(date-time) The end time of the event

1768 | P a g e
 Outlook.com

End time
EndTimeZone string This property specifies
End time zone the time zone of the
meeting end time. The
value must be as defined
in Windows (example:
'Pacific Standard Time').
HasAttachments boolean Set to true if the event
Has attachments? has attachments
Importance string The importance of the
Importance event: Low, Normal, or
High Values: [Low,
Normal, High]
IsAllDay boolean Set to true if the event
Is all day event? lasts all day
IsCancelled boolean Set to true if the event
Is cancelled? has been canceled
IsOrganizer boolean Set to true if the message
Is Organizer sender is also the
organizer
Location Location

Organizer Recipient

Recurrence PatternedRecurrence

Reminder integer(int32) Time in minutes before

Reminder event start to remind

1769 | P a g e
 Outlook.com

ResponseRequested boolean Set to true if the sender

Response requested would like a response
when the event is
accepted or declined
ResponseStatus ResponseStatus

SeriesMasterId string Unique identifier for

Series master id Series Master event type
ShowAs string Shows as free or busy
Show as Values: [Free, Tentative,
Busy, Oof,
WorkingElsewhere,
Unknown]
Start string(date-time) The start time of the
Start time event
StartTimeZone string This property specifies
Start time zone the time zone of the
meeting start time. The
value must be as defined
in Windows (example:
'Pacific Standard Time').
Subject string Event subject
Subject
Type string The event type: Single
Type Instance, Occurrence,
Exception, or Series
Master Values:
[SingleInstance,

1770 | P a g e
 Outlook.com

Occurrence, Exception,
SeriesMaster]
WebLink string The preview of the
Web link message associated with
the event

1771 | P a g e
 Outlook.com

CalendarEventClient
Summary:
Description: Connector specific calendar event model class for the client

Properties:
Name Type Summary
Subject string Event subject
Subject
Start string(date-time) Start time of the event
Start time (example: '2016-11-
01T14:30:00')
End string(date-time) End time of the event
End time (example: '2016-11-
01T15:30:00')
TimeZone string Time zone of the event,
Time zone specified as a time zone
index value (example:
'Pacific Standard Time')
RequiredAttendees string(email) Required attendees for the
Required attendees event
OptionalAttendees string(email) Optional attendees for the
Optional attendees event
Body string Body of the message
Body associated with the event
IsHtml boolean Set to true if the body is
Is HTML Html
Location string Location of the event
Location

1772 | P a g e
 Outlook.com

Importance string The importance of the

Importance event: Low, Normal, or
High Values: [Low,
Normal, High]
IsAllDay boolean Set to true if the event
Is all day event? lasts all day
Recurrence string The recurrence pattern for
Recurrence the event Values: [None,
Daily, Weekly, Monthly,
Yearly]
Reminder integer(int32) Time in minutes before
Reminder event start to remind
ShowAs string Status to show during the
Show as event Values: [Free,
Tentative, Busy, Oof,
WorkingElsewhere,
Unknown]

1773 | P a g e
 Outlook.com

CalendarEventClientReceive
Summary:
Description: Connector specific calendar event model class for the client

Properties:
Name Type Summary
Id string The event's unique
Id identifier
DateTimeCreated string(date-time) The date and time that the
Created time event was created
DateTimeLastModified string(date-time) The date and time that the
Last modified time event was last modified
Subject string Event subject
Subject
Start string(date-time) Start time of the event
Start time (example: '2016-11-
01T14:30:00')
End string(date-time) End time of the event
End time (example: '2016-11-
01T15:30:00')
TimeZone string Time zone of the event,
Time zone specified as a time zone
index value (example:
'Pacific Standard Time')
RequiredAttendees string(email) Required attendees for
Required attendees the event
OptionalAttendees string(email) Optional attendees for the
Optional attendees event

1774 | P a g e
 Outlook.com

Body string Body of the message

Body associated with the event
IsHtml boolean Set to true if the body is
Is HTML Html
Location string Location of the event
Location
Importance string The importance of the
Importance event: Low, Normal, or
High Values: [Low,
Normal, High]
IsAllDay boolean Set to true if the event
Is all day event? lasts all day
Recurrence string The recurrence pattern for
Recurrence the event Values: [None,
Daily, Weekly, Monthly,
Yearly]
Reminder integer(int32) Time in minutes before
Reminder event start to remind
ShowAs string Status to show during the
Show as event Values: [Free,
Tentative, Busy, Oof,
WorkingElsewhere,
Unknown]

1775 | P a g e
 Outlook.com

CalendarEventList
Summary:
Description: The list of calendar items

Properties:
Name Type Summary
value array of List of calendar items
(CalendarEventBackend)

1776 | P a g e
 Outlook.com

CalendarEventListClientReceive
Summary:
Description: The list of calendar items

Properties:
Name Type Summary
value array of List of calendar items
(CalendarEventClientReceive)

1777 | P a g e
 Outlook.com

Contact
Summary:
Description: Contact

Properties:
Name Type Summary
Id string The contact's unique
Id identifier.
ParentFolderId string The ID of the contact's
Parent folder id parent folder
Birthday string(date-time) The contact's birthday
Birthday
FileAs string The name the contact is
File as filed under
DisplayName string The contact's display
Display Name name
GivenName string The contact's given name
Given name
Initials string The contact's initials
Initials
MiddleName string The contact's middle
Middle name name
NickName string The contact's nickname
Nickname
Surname string The contact's surname
Surname
Title string The contact's title
Title
Generation string The contact's generation

1778 | P a g e
 Outlook.com

Generation
EmailAddresses array of (EmailAddress) The contact's email
Email addresses addresses
ImAddresses array of (string) The contact's instant
IM addresses messaging (IM)
addresses
JobTitle string The contact's job title
JobTitle
CompanyName string The name of the
Company name contact's company
Department string The contact's
Department department
OfficeLocation string The location of the
Office location contact's office
Profession string The contact's profession
Profession
BusinessHomePage string The business home page
Business home page of the contact
AssistantName string The name of the
Assistant name contact's assistant
Manager string The name of the
Manager contact's manager
HomePhones array of (string) The contact's home
Home phones phone numbers
BusinessPhones array of (string) The contact's business
Business phones phone numbers
MobilePhone1 string The contact's mobile
Mobile phone phone number
HomeAddress PhysicalAddress

1779 | P a g e
 Outlook.com

BusinessAddress PhysicalAddress

OtherAddress PhysicalAddress

YomiCompanyName string The phonetic Japanese

Yomi company name company name of the
contact
YomiGivenName string The phonetic Japanese
Yomi given name given name (first name)
of the contact
YomiSurname string The phonetic Japanese
Yomi surname surname (last name) of
the contact
Categories array of (string) The categories
Categories associated with the
contact
ChangeKey string Identifies the version of
Change key the event object
DateTimeCreated string(date-time) The time the contact was
Created time created
DateTimeLastModified string(date-time) The time the contact was
Last modified time modified

1780 | P a g e
 Outlook.com

ContactList
Summary:
Description: The list of contacts

Properties:
Name Type Summary
value array of (Contact) List of contacts

1781 | P a g e
 Outlook.com

DataSet
Summary:
Description:

Properties:
Name Type Summary
Name string

DisplayName string

1782 | P a g e
 Outlook.com

DataSetsList
Summary:
Description:

Properties:
Name Type Summary
value array of (DataSet)

1783 | P a g e
 Outlook.com

DataSetsMetadata
Summary:
Description:

Properties:
Name Type Summary
tabular TabularDataSetsMetadata

blob BlobDataSetsMetadata

1784 | P a g e
 Outlook.com

DigestMessage
Summary:
Description: Send Email Message

Properties:
Name Type Summary
Subject string Subject
Subject
Body string Body
Body
Importance string Importance Values: [Low,
Importance Normal, High]
Digest array of (string) Digest

Attachments array of (SendAttachment) Attachments

Attachments
To string(email) To
To

1785 | P a g e
 Outlook.com

EmailAddress
Summary:
Description:

Properties:
Name Type Summary
Name string

Address string

1786 | P a g e
 Outlook.com

FilePickerFolder
Summary:
Description: Folder

Properties:
Name Type Summary
Id string Id

DisplayName string Display name

Path string Path

IsFolder boolean Is Folder?

1787 | P a g e
 Outlook.com

GeoCoordinates
Summary:
Description:

Properties:
Name Type Summary
Altitude number(double)

Latitude number(double)

Longitude number(double)

Accuracy number(double)

AltitudeAccuracy number(double)

1788 | P a g e
 Outlook.com

Item
Summary:
Description:

Properties:
Name Type Summary
ItemInternalId string

1789 | P a g e
 Outlook.com

ItemBody
Summary:
Description:

Properties:
Name Type Summary
ContentType string Values: [Text, HTML]

Content string

1790 | P a g e
 Outlook.com

ItemsList
Summary:
Description:

Properties:
Name Type Summary
value array of (Item)

1791 | P a g e
 Outlook.com

Location
Summary:
Description:

Properties:
Name Type Summary
DisplayName string

Address PhysicalAddress

Coordinates GeoCoordinates

1792 | P a g e
 Outlook.com

MessageWithOptions
Summary:
Description: User Options Email Message. This is the message expected as part of user
input

Properties:
Name Type Summary
To string(email) Specify email addresses
To separated by semicolons
like
[email protected]
Subject string Subject of the email
Subject
Options string List of comma separated
User Options options for the email
response
Body string Body of the email
Body
Importance string Importance Values: [Low,
Importance Normal, High]
Attachments array of (SendAttachment) Attachments
Attachments

1793 | P a g e
 Outlook.com

Object
Summary:
Description:

Properties:
Name Type Summary

1794 | P a g e
 Outlook.com

OptionsEmailSubscription
Summary:
Description: Model for Options Email Subscription

Properties:
Name Type Summary
NotificationUrl string Gets or sets callback url
to flow engine. It is
expected as part of
request
Message MessageWithOptions User Options Email
Message. This is the
message expected as
part of user input

1795 | P a g e
 Outlook.com

PageListResponse[FilePickerFolder]
Summary:
Description: Response containing a list and next link

Properties:
Name Type Summary
value array of (FilePickerFolder) Value

nextLink string Next page link

1796 | P a g e
 Outlook.com

PatternedRecurrence
Summary:
Description:

Properties:
Name Type Summary
Pattern RecurrencePattern

Range RecurrenceRange

1797 | P a g e
 Outlook.com

PhysicalAddress
Summary:
Description:

Properties:
Name Type Summary
Street string

City string

State string

CountryOrRegion string

PostalCode string

1798 | P a g e
 Outlook.com

ReceiveAttachment
Summary:
Description: Receive Attachment

Properties:
Name Type Summary
Id string The attachment Id
Attachment Id
ContentType string The content type of the
Content-Type attachment
Size integer(int64) The size in bytes of the
attachment
@odata.type string Attachment Type

Name string Attachment name

Name
ContentBytes string(byte) Attachment content
Content

1799 | P a g e
 Outlook.com

ReceiveMessage
Summary:
Description: Receive Email Message

Properties:
Name Type Summary
From string(email) The mailbox owner and
From sender of the message
To string(email) The recipients for the
To message
Cc string(email) The Cc recipients for the
CC message
Bcc string(email) The Bcc recipients for the
BCC message
Subject string The subject of the
Subject message
Body string The body of the message
Body
Importance string The importance of the
Importance message Values: [Low,
Normal, High]
HasAttachment boolean Indicates whether the
Has Attachment message has
attachments
Id string The unique identifier of
Message Id the message
ConversationId string The Id of the
Conversation Id conversation the email
belongs to

1800 | P a g e
 Outlook.com

DateTimeReceived string(date-time) The date and time the

Received Time message was received
IsRead boolean Indicates whether the
Is Read message has been read
Attachments array of The attachments for the
(ReceiveAttachment) message
Attachments
IsHtml boolean Is Html?
Is HTML

1801 | P a g e
 Outlook.com

Recipient
Summary:
Description:

Properties:
Name Type Summary
EmailAddress EmailAddress

1802 | P a g e
 Outlook.com

RecurrencePattern
Summary:
Description:

Properties:
Name Type Summary
Type string Values: [Daily, Weekly,
AbsoluteMonthly,
RelativeMonthly,
AbsoluteYearly,
RelativeYearly]
Interval integer(int32)

Month integer(int32)

DayOfMonth integer(int32)

DaysOfWeek array of (string)

FirstDayOfWeek string Values: [Sunday, Monday,

Tuesday, Wednesday,
Thursday, Friday,
Saturday]
Index string Values: [First, Second,
Third, Fourth, Last]

1803 | P a g e
 Outlook.com

RecurrenceRange
Summary:
Description:

Properties:
Name Type Summary
Type string Values: [EndDate, NoEnd,
Numbered]
StartDate string(date-time)

EndDate string(date-time)

NumberOfOccurrences integer(int32)

1804 | P a g e
 Outlook.com

ResponseStatus
Summary:
Description:

Properties:
Name Type Summary
Response string Values: [None, Organizer,
TentativelyAccepted,
Accepted, Declined,
NotResponded]
Time string(date-time)

1805 | P a g e
 Outlook.com

SendAttachment
Summary:
Description: Attachment

Properties:
Name Type Summary
@odata.type string Attachment Type

Name string Attachment name

Name
ContentBytes string(byte) Attachment content
Content

1806 | P a g e
 Outlook.com

SendMessage
Summary:
Description: Send Email Message

Properties:
Name Type Summary
From string(email) Email address to send
From message from
Cc string(email) Specify email addresses
CC separated by semicolons
like
[email protected]
Bcc string(email) Specify email addresses
BCC separated by semicolons
like
[email protected]
To string(email) Specify email addresses
To separated by semicolons
like
[email protected]
Subject string Specify the subject of the
Subject mail
Body string Specify the body of the mail
Body
Attachments array of (SendAttachment) Attachments
Attachments
Importance string Importance Values: [Low,
Importance Normal, High]
IsHtml boolean Is Html?

1807 | P a g e
 Outlook.com

Is HTML

1808 | P a g e
 Outlook.com

SubscriptionResponse
Summary:
Description: Model for Approval Email Subscription

Properties:
Name Type Summary
id string Id of the subscription

resource string Resource of the

subscription request
notificationType string Notification Type

notificationUrl string Notification Url

1809 | P a g e
 Outlook.com

Table
Summary:
Description:

Properties:
Name Type Summary
Name string

DisplayName string

1810 | P a g e
 Outlook.com

TableCapabilitiesMetadata
Summary:
Description:

Properties:
Name Type Summary
sortRestrictions TableSortRestrictionsMetadata

filterRestrictions TableFilterRestrictionsMetadata

isOnlyServerPagable boolean

filterFunctionSupport array of (string)

1811 | P a g e
 Outlook.com

TableFilterRestrictionsMetadata
Summary:
Description:

Properties:
Name Type Summary
filterable boolean

nonFilterableProperties array of (string)

requiredProperties array of (string)

1812 | P a g e
 Outlook.com

TableMetadata
Summary:
Description:

Properties:
Name Type Summary
name string

title string

x-ms-permission string

x-ms-capabilities TableCapabilitiesMetadata

schema Object

referencedEntities Object

1813 | P a g e
 Outlook.com

TablesList
Summary:
Description:

Properties:
Name Type Summary
value array of (Table)

1814 | P a g e
 Outlook.com

TableSortRestrictionsMetadata
Summary:
Description:

Properties:
Name Type Summary
sortable boolean

unsortableProperties array of (string)

ascendingOnlyProperties array of (string)

1815 | P a g e
 Outlook.com

TabularDataSetsMetadata
Summary:
Description:

Properties:
Name Type Summary
source string

displayName string

urlEncoding string

tableDisplayName string

tablePluralName string

1816 | P a g e
 Outlook.com

TriggerBatchResponse[ReceiveMessage]
Summary:
Description:

Properties:
Name Type Summary
value array of (ReceiveMessage)

1817 | P a g e
 PagerDuty

PagerDuty
PagerDuty is an agile incident management platform that integrates with IT
Ops and DevOps monitoring stacks to improve operational reliability and
agility for organizations.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
GetIncidents () List incidents
GetIncidentByKey (string Get incident
incident_key)
GetActiveIncidents () List active incidents
GetEscalationPolicies () Get all the escalation policies
GetUsers () Get all the users
GetUser (string userId) Get user by ID
GetIncidentNotes (string Get all the notes for an incident
incidentId)
AddNoteToIncident (string Add note to incident
incidentId, AddNoteRequest
request)
AcknowledgeIncident (string Acknowledge incident
incidentId,
AcknowledgeRequest
request)
ResolveIncident (string Resolve incident
incidentId, ResolveRequest
request)

1818 | P a g e
 PagerDuty

ReassignIncident (string Reassign incident

incidentId, ReassignRequest
request)
SnoozeIncident (string Snooze incident
incidentId, SnoozeRequest
request)
EscalateIncident (string Escalate incident
incidentId, EscalateRequest
request)
GetIncidentById (string Get incident
incidentId)
CreateIncident Create incident
(CreateRequest request)

Triggers:
Name Summary
OnNewIncidentNote (string When a note is added
incidentId)
OnNewIncidentCreated () When an incident is created
OnIncidentAssigned (string When an incident is assigned to a user
userId)
OnIncidentAcknowledged () When an incident is acknowledged
OnIncidentResolved () When an incident is resolved

Objects:
Name Summary
Acknowledgement
Acknowledger

1819 | P a g e
 PagerDuty

AcknowledgeRequest
AddNoteRequest
AddNoteResponse
Assignee
Assignment
ContactMethod
CreateRequest
EscalateRequest
EscalationPoliciesResponse
EscalationPolicy
FirstTriggerLogEntry
Incident
IncidentsResponse
LastStatusChangeBy
NewIncident
Note
NoteResponse
NotesResponse
NotificationRule
Object
PendingAction
ReassignRequest
ResolveRequest
Service
SnoozeRequest
Team
User
UserResponse

1820 | P a g e
 PagerDuty

UsersResponse

Actions:
GetIncidents
Summary: List incidents
Description: List incidents

Syntax:
PagerDuty.GetIncidents ()

Returns:
Type:IncidentsResponse
Description: Response for a list of incidents

GetIncidentByKey
Summary: Get incident
Description: Retrieves incident object by incident key.

Syntax:
PagerDuty.GetIncidentByKey (string incident_key)

Parameters:
Name Type Summary Required Related
Action
incident_key string Incident key True
(Incident)

Returns:
Type:Incident
1821 | P a g e
 PagerDuty

Description: An incident

GetActiveIncidents
Summary: List active incidents
Description: List active incidents

Syntax:
PagerDuty.GetActiveIncidents ()

Returns:
Type:IncidentsResponse
Description: Response for a list of incidents

GetEscalationPolicies
Summary: Get all the escalation policies
Description: Get all the escalation policies

Syntax:
PagerDuty.GetEscalationPolicies ()

Returns:
Type:EscalationPoliciesResponse
Description: Escalation policies response object

GetUsers
Summary: Get all the users
Description: Get all the users

Syntax:

1822 | P a g e
 PagerDuty

PagerDuty.GetUsers ()

Returns:
Type:UsersResponse
Description: Users response object

GetUser
Summary: Get user by ID
Description: Retrieves the user's information for a given ID.

Syntax:
PagerDuty.GetUser (string userId)

Parameters:
Name Type Summary Required Related
Action
userId string True
(User Id)

Returns:
Type:User
Description: A PagerDuty user

GetIncidentNotes
Summary: Get all the notes for an incident
Description: Get all the notes for an incident

Syntax:
PagerDuty.GetIncidentNotes (string incidentId)

1823 | P a g e
 PagerDuty

Parameters:
Name Type Summary Required Related
Action
incidentId string Incident True
(Incident) identifier

Returns:
Type:NotesResponse
Description: Response object for notes

AddNoteToIncident
Summary: Add note to incident
Description: Add note to a given incident.

Syntax:
PagerDuty.AddNoteToIncident (string incidentId, AddNoteRequest
request)

Parameters:
Name Type Summary Required Related Action
incidentId string Select an True GetActiveIncidents
(Incident) incident
request AddNoteRequest Request to True
add a note
to an
incident

Returns:

1824 | P a g e
 PagerDuty

Type:AddNoteResponse
Description: Response to AddNoteToIncident endpoint

AcknowledgeIncident
Summary: Acknowledge incident
Description: Acknowledge a given incident.

Syntax:
PagerDuty.AcknowledgeIncident (string incidentId,
AcknowledgeRequest request)

Parameters:
Name Type Summary Required Related Action
incidentId string Select an True GetActiveIncidents
(Incident) incident
request AcknowledgeRequest Request to True
acknowledge
an incident

Returns:
Type:Incident
Description: An incident

ResolveIncident
Summary: Resolve incident
Description: Mark a given incident as resolved.

Syntax:

1825 | P a g e
 PagerDuty

PagerDuty.ResolveIncident (string incidentId, ResolveRequest

request)

Parameters:
Name Type Summary Required Related Action
incidentId string Select an True GetActiveIncidents
(Incident) incident
request ResolveRequest Request to True
resolve an
incident

Returns:
Type:Incident
Description: An incident

ReassignIncident
Summary: Reassign incident
Description: Reassign a given incident.

Syntax:
PagerDuty.ReassignIncident (string incidentId, ReassignRequest
request)

Parameters:
Name Type Summary Required Related Action
incidentId string Select an True GetActiveIncidents
(Incident) incident
request ReassignRequest Request True
object to

1826 | P a g e
 PagerDuty

reassign an
incident

Returns:
Type:Incident
Description: An incident

SnoozeIncident
Summary: Snooze incident
Description: Snooze a given incident by a certain time.

Syntax:
PagerDuty.SnoozeIncident (string incidentId, SnoozeRequest
request)

Parameters:
Name Type Summary Required Related Action
incidentId string Select an True GetActiveIncidents
(Incident) incident
request SnoozeRequest Request to True
snooze an
incident

Returns:
Type:Incident
Description: An incident

EscalateIncident
Summary: Escalate incident

1827 | P a g e
 PagerDuty

Description: Use a given escalation policy on an incident.

Syntax:
PagerDuty.EscalateIncident (string incidentId, EscalateRequest
request)

Parameters:
Name Type Summary Required Related Action
incidentId string Select an True GetActiveIncidents
(Incident) incident
request EscalateRequest Request True
object to
escalate an
incident

Returns:
Type:Incident
Description: An incident

GetIncidentById
Summary: Get incident
Description: Retrieves incident object by incident key.

Syntax:
PagerDuty.GetIncidentById (string incidentId)

Parameters:
Name Type Summary Required Related
Action

1828 | P a g e
 PagerDuty

incidentId string True

Returns:
Type:Incident
Description: An incident

CreateIncident
Summary: Create incident
Description: Creates a new incident for a given service identifiable by the integration
key.

Syntax:
PagerDuty.CreateIncident (CreateRequest request)

Parameters:
Name Type Summary Required Related
Action
request CreateRequest Request to True
create an
incident

Returns:
Type:NewIncident
Description: A new incident

Triggers:
Trigger OnNewIncidentNote
Summary: When a note is added

1829 | P a g e
 PagerDuty

Description: Triggers when a note is added to the given incident.

Syntax:
PagerDuty.OnNewIncidentNote (string incidentId)

Parameters:
Name Type Summary Required Related Action
incidentId string Select an True GetActiveIncidents
(Incident) incident

Returns:
Type:NotesResponse
Description: Response object for notes

Trigger OnNewIncidentCreated
Summary: When an incident is created
Description: Triggers when a new incident is created.

Syntax:
PagerDuty.OnNewIncidentCreated ()

Returns:
Type:IncidentsResponse
Description: Response for a list of incidents

Trigger OnIncidentAssigned
Summary: When an incident is assigned to a user
Description: Triggers when an incident is assigned to the given user.

1830 | P a g e
 PagerDuty

Syntax:
PagerDuty.OnIncidentAssigned (string userId)

Parameters:
Name Type Summary Required Related
Action
userId string Select a user True GetUsers
(User)

Returns:
Type:IncidentsResponse
Description: Response for a list of incidents

Trigger OnIncidentAcknowledged
Summary: When an incident is acknowledged
Description: Triggers when an existing incident is acknowledged.

Syntax:
PagerDuty.OnIncidentAcknowledged ()

Returns:
Type:IncidentsResponse
Description: Response for a list of incidents

Trigger OnIncidentResolved
Summary: When an incident is resolved
Description: Triggers when an existing incident is resolved.

Syntax:

1831 | P a g e
 PagerDuty

PagerDuty.OnIncidentResolved ()

Returns:
Type:IncidentsResponse
Description: Response for a list of incidents

1832 | P a g e
 PagerDuty

Acknowledgement
Summary:
Description: Acknowledgement of incident

Properties:
Name Type Summary
at string Time acknowledgement
Time acknowledgement was created
was created
acknowledger Acknowledger Represents the
acknowledger of an
incident

1833 | P a g e
 PagerDuty

Acknowledger
Summary:
Description: Represents the acknowledger of an incident

Properties:
Name Type Summary
id string Acknowledger Id
Acknowledger Id
type string Acknowledger type
Acknowledger type
summary string A generated string that
A generated string that provides succinct,
provides succinct, important information
important information about the acknowledger
about the acknowledger
self string The API show URL at which
The API show URL at which the object is accessible
the object is accessible
html_url string A URL at which the entity
A URL at which the entity is uniquely displayed in the
is uniquely displayed in the Web app
Web app

1834 | P a g e
 PagerDuty

AcknowledgeRequest
Summary:
Description: Request to acknowledge an incident

Properties:
Name Type Summary
userId string Select a user
Acknowledged by

1835 | P a g e
 PagerDuty

AddNoteRequest
Summary:
Description: Request to add a note to an incident

Properties:
Name Type Summary
userId string Select a user
Added by
note string Text for the note
Note

1836 | P a g e
 PagerDuty

AddNoteResponse
Summary:
Description: Response to AddNoteToIncident endpoint

Properties:
Name Type Summary
user UserResponse User response

note NoteResponse Note Response

1837 | P a g e
 PagerDuty

Assignee
Summary:
Description: Represents to whom the incident is assigned

Properties:
Name Type Summary
id string Assignee Id
Assignee Id
type string Assignee type
Assignee type
summary string A generated string that
A generated string that provides succinct,
provides succinct, important information
important information about the acknowledger
about the acknowledger
self string The API show URL at which
The API show URL at which the object is accessible
the object is accessible
html_url string A URL at which the entity
A URL at which the entity is uniquely displayed in
is uniquely displayed in the Web app
the Web app

1838 | P a g e
 PagerDuty

Assignment
Summary:
Description: Represents the assignment of an incident

Properties:
Name Type Summary
at string Time assignment was
Time assignment was created
created
assignee Assignee Represents to whom the
incident is assigned

1839 | P a g e
 PagerDuty

ContactMethod
Summary:
Description: The method for contact

Properties:
Name Type Summary
id string Contact method Id
Contact method Id
type string Contact method type
Contact method type
summary string A generated string that
A generated string that provides succinct,
provides succinct, important information
important information about the contact method
about the contact method
self string The API show URL at
The API show URL at which the object is
which the object is accessible
accessible
html_url Object

1840 | P a g e
 PagerDuty

CreateRequest
Summary:
Description: Request to create an incident

Properties:
Name Type Summary
service_key string(string) Service integration key
Service key from PagerDuty
description string(string) Description of the incident
Description

1841 | P a g e
 PagerDuty

EscalateRequest
Summary:
Description: Request object to escalate an incident

Properties:
Name Type Summary
userId string Select a user
Escalated by
policyId string Select a policy
Escalation policy

1842 | P a g e
 PagerDuty

EscalationPoliciesResponse
Summary:
Description: Escalation policies response object

Properties:
Name Type Summary
escalation_policies array of (EscalationPolicy) List of escalation policies
Escalation policies
limit integer(int32) Pagination limit
Pagination limit
offset integer(int32) Pagination offset
Pagination offset
more boolean Indicates if there are
Indicates if there are additional policies to
additional policies to return
return
total Object

1843 | P a g e
 PagerDuty

EscalationPolicy
Summary:
Description: The policy in place for escalating an incident

Properties:
Name Type Summary
id string Policy Id
Policy Id
type string Policy type
Policy type
summary string A generated string that
A generated string that provides succinct,
provides succinct, important information
important information about the policy
about the policy
self string The API show URL at
The API show URL at which the object is
which the object is accessible
accessible
html_url string A URL at which the entity
A URL at which the entity is uniquely displayed in
is uniquely displayed in the Web app
the Web app

1844 | P a g e
 PagerDuty

FirstTriggerLogEntry
Summary:
Description: Log entry for when an incident is triggered

Properties:
Name Type Summary
id string Log entry Id
Log entry Id
type string Log entry type
Log entry type
summary string A generated string that
A generated string that provides succinct,
provides succinct, important information
important information about the log entry
about the log entry
self string The API show URL at
The API show URL at which the object is
which the object is accessible
accessible
html_url string A URL at which the entity
A URL at which the entity is uniquely displayed in
is uniquely displayed in the Web app
the Web app

1845 | P a g e
 PagerDuty

Incident
Summary:
Description: An incident

Properties:
Name Type Summary
id string Incident Id
Incident Id
type string Incident type
Incident type
summary string Incident title
Incident title
self string The API show URL at
The API show URL at which the object is
which the object is accessible
accessible
html_url string Incident detail url
Incident detail url
incident_number integer(int32) Incident number
Incident number
created_at string Create date
Create date
status string Current status
Current status
pending_actions array of (PendingAction) List of pending actions
List of pending actions
incident_key string Incident Key
Incident Key
service Service A service

1846 | P a g e
 PagerDuty

assignments array of (Assignment) List of all assignments for

List of all assignments for this incident
this incident
assignedUserId string The ID of the user
Assigned User ID assigned to this incident
acknowledgements array of List of all
(Acknowledgement) acknowledgements for
List of all this incident
acknowledgements for
this incident
last_status_change_at string Last status change
Last status change
last_status_change_by LastStatusChangeBy Represents the user or
service that last changed
an incident
first_trigger_log_entry FirstTriggerLogEntry Log entry for when an
incident is triggered
escalation_policy EscalationPolicy The policy in place for
escalating an incident
teams array of (Team) Teams involved in the
Teams involved in the incident lifecycle
incident lifecycle
urgency string Current urgency
Current urgency

1847 | P a g e
 PagerDuty

IncidentsResponse
Summary:
Description: Response for a list of incidents

Properties:
Name Type Summary
incidents array of (Incident) List of incidents
List of incidents

1848 | P a g e
 PagerDuty

LastStatusChangeBy
Summary:
Description: Represents the user or service that last changed an incident

Properties:
Name Type Summary
id string Last status change Id
Last status change Id
type string Last status change type
Last status change type
summary string A generated string that
A generated string that provides succinct,
provides succinct, important information
important information about the last status
about the policy change
self string The API show URL at
The API show URL at which the object is
which the object is accessible
accessible
html_url string A URL at which the entity
A URL at which the entity is uniquely displayed in
is uniquely displayed in the Web app
the Web app

1849 | P a g e
 PagerDuty

NewIncident
Summary:
Description: A new incident

Properties:
Name Type Summary
incident_key string Key
Key

1850 | P a g e
 PagerDuty

Note
Summary:
Description: A note for an incident

Properties:
Name Type Summary
content string Note content
Note content

1851 | P a g e
 PagerDuty

NoteResponse
Summary:
Description: Note Response

Properties:
Name Type Summary
id string Unique identifier of the
Unique identifier of the user
user
user UserResponse User response

content string Note content

Note content
created_at string Date and time the note
Date and time the note was created
was created

1852 | P a g e
 PagerDuty

NotesResponse
Summary:
Description: Response object for notes

Properties:
Name Type Summary
notes array of (Note) List of notes
Notes

1853 | P a g e
 PagerDuty

NotificationRule
Summary:
Description: Notification rule

Properties:
Name Type Summary
id string Notification rule Id
Notification rule Id
type string Rule type
Rule type
summary string A generated string that
A generated string that provides succinct,
provides succinct, important information
important information about the rule
about the rule
self string The API show URL at
The API show URL at which the object is
which the object is accessible
accessible
html_url Object

1854 | P a g e
 PagerDuty

Object
Summary:
Description:

Properties:
Name Type Summary

1855 | P a g e
 PagerDuty

PendingAction
Summary:
Description: An incident action that is pending

Properties:
Name Type Summary
type string Pending action type
Pending action type
at string Create date
Create date

1856 | P a g e
 PagerDuty

ReassignRequest
Summary:
Description: Request object to reassign an incident

Properties:
Name Type Summary
userId string Select a user
From user
reassignUserId string Select a user
To user

1857 | P a g e
 PagerDuty

ResolveRequest
Summary:
Description: Request to resolve an incident

Properties:
Name Type Summary
userId string Select a user
Resolved by

1858 | P a g e
 PagerDuty

Service
Summary:
Description: A service

Properties:
Name Type Summary
id string Service Id
Service Id
type string Service type
Service type
summary string A generated string that
A generated string that provides succinct,
provides succinct, important information
important information about the service
about the service
self string The API show URL at
The API show URL at which the object is
which the object is accessible
accessible
html_url string A URL at which the entity
A URL at which the entity is uniquely displayed in
is uniquely displayed in the Web app
the Web app

1859 | P a g e
 PagerDuty

SnoozeRequest
Summary:
Description: Request to snooze an incident

Properties:
Name Type Summary
userId string Select a user
Snoozed by
duration integer(int32) The amount of time, in
Snooze seconds, to snooze the
incident

1860 | P a g e
 PagerDuty

Team
Summary:
Description: A team

Properties:
Name Type Summary
id string Team Id
Team Id
type string Team type
Team type
summary string A generated string that
A generated string that provides succinct,
provides succinct, important information
important information about the team
about the team
self string The API show URL at
The API show URL at which the object is
which the object is accessible
accessible
html_url string A URL at which the entity
A URL at which the entity is uniquely displayed in
is uniquely displayed in the Web app
the Web app

1861 | P a g e
 PagerDuty

User
Summary:
Description: A PagerDuty user

Properties:
Name Type Summary
name string Name
Name
email string E-mail address
E-mail address
time_zone string The preferred time zone
The preferred time zone name. If null, the account
name. If null, the account time zone will be used
time zone will be used
color string Schedule color
Schedule color
avatar_url string User avatar url
User avatar url
billed boolean User is billed
User is billed
role string The user role
The user role
description Object

invitation_sent boolean Outstanding invitation

Outstanding invitation for for the user
the user
contact_methods array of (ContactMethod) Contact methods for the
user

1862 | P a g e
 PagerDuty

Contact methods for the

user
notification_rules array of (NotificationRule) Notification rules for the
Notification rules for the user
user
job_title Object

teams array of (Object) Teams to which the user

Teams to which the user belongs
belongs
coordinated_incidents array of (Object) List of incidents for this
List of incidents for this user
user
id string User Id
User Id
type string User type
User type
summary string A generated string that
A generated string that provides succinct,
provides succinct, important information
important information about the user
about the user
self string The API show URL at
The API show URL at which the object is
which the object is accessible
accessible
html_url string A URL at which the entity
is uniquely displayed in
the Web app

1863 | P a g e
 PagerDuty

A URL at which the entity

is uniquely displayed in
the Web app

1864 | P a g e
 PagerDuty

UserResponse
Summary:
Description: User response

Properties:
Name Type Summary
id string User Id
User Id
type string User type
User type
summary string A generated string that
A generated string that provides succinct,
provides succinct, important information
important information about the user
about the user
self string The API show URL at
The API show URL at which the object is
which the object is accessible
accessible
html_url string A URL at which the entity
A URL at which the entity is uniquely displayed in
is uniquely displayed in the Web app
the Web app

1865 | P a g e
 PagerDuty

UsersResponse
Summary:
Description: Users response object

Properties:
Name Type Summary
users array of (User) List of users
Users
limit integer(int32) Pagination limit
Pagination limit
offset integer(int32) Pagination offset
Pagination offset
total Object

more boolean Indicates if there are

Indicates if there are additional users to return
additional users to return

1866 | P a g e
 Pinterest

Pinterest
Pinterest allows you to create a bulletin of photos called a Board. You can
follow boards, add pins to existing ones or collaborate with people to build
shared boards.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
ListFollowBoards () List boards I follow
ListMyBoards () List my boards
CreateBoard (string name, Create board
[Optional]string description)
EditBoard (string board, string Edit board
name,
[advanced][Optional]string
description)
ListAllPins () List all pins
ListPinsFromBoard (string List pins from a board
board)
CreatePin (string board, string Create pin
note, string image_url,
[advanced][Optional]string
link)
EditPin (string board, string Edit pin
pin, string note,
[advanced][Optional]string

1867 | P a g e
 Pinterest

link, [Optional]string
secondBoard)
GetCurrentUser () Get current user
ListMyFollowers () List my followers
ListMyFollowings () List my followings

Triggers:
Name Summary
OnPinAddedToFollowedBoard When pin is added to followed board
(string board)
OnPinAddedToMyBoard When pin is added to my board
(string board)
OnSomeoneFollowsMe () When someone follows me

Objects:
Name Summary
BoardResponse
BoardResponseData
PinResponse
PinResponseData
UserResponse
UserResponseData
UserResponsePage

Actions:
ListFollowBoards
Summary: List boards I follow
Description: List boards I follow

1868 | P a g e
 Pinterest

Syntax:
Pinterest.ListFollowBoards ()

Returns:
Type:BoardResponse
Description: BoardResponse

ListMyBoards
Summary: List my boards
Description: List my boards

Syntax:
Pinterest.ListMyBoards ()

Returns:
Type:BoardResponse
Description: BoardResponse

CreateBoard
Summary: Create board
Description: Create board

Syntax:
Pinterest.CreateBoard (string name, [Optional]string
description)

Parameters:

1869 | P a g e
 Pinterest

Name Type Summary Required Related

Action
name string Name True
(Name)
description string Description False
(Description)

Returns:
Type:BoardResponseData
Description: BoardResponseData

EditBoard
Summary: Edit board
Description: Edit board

Syntax:
Pinterest.EditBoard (string board, string name,
[advanced][Optional]string description)

Parameters:
Name Type Summary Required Related
Action
board string Board True ListMyBoards
(Board)
name string Name True
(Name)
description string Description False
(Description)

1870 | P a g e
 Pinterest

Returns:
Type:BoardResponse
Description: BoardResponse

ListAllPins
Summary: List all pins
Description: List all pins

Syntax:
Pinterest.ListAllPins ()

Returns:
Type:string

ListPinsFromBoard
Summary: List pins from a board
Description: List pins from a board

Syntax:
Pinterest.ListPinsFromBoard (string board)

Parameters:
Name Type Summary Required Related
Action
board string Board True ListMyBoards
(Board)

Returns:
Type:PinResponse

1871 | P a g e
 Pinterest

Description: PinResponse

CreatePin
Summary: Create pin
Description: Create pin

Syntax:
Pinterest.CreatePin (string board, string note, string
image_url, [advanced][Optional]string link)

Parameters:
Name Type Summary Required Related
Action
board string Board True ListMyBoards
(Board)
note string The user- True
(Note) entered
description of
the pin
image_url string The link to the True
(Image Url) image that you
want to pin
(source)
link string The url the pin False
(Link) will link to when
you click
through

Returns:

1872 | P a g e
 Pinterest

Type:PinResponseData
Description: PinResponseData

EditPin
Summary: Edit pin
Description: Edit pin

Syntax:
Pinterest.EditPin (string board, string pin, string note,
[advanced][Optional]string link, [Optional]string secondBoard)

Parameters:
Name Type Summary Required Related Action
board string Board True ListMyBoards
(Board)
pin string Pin True ListPinsFromBoard
(Pin)
note string The user- True
(Note) entered
description of
the pin
link string The url the pin False
(Link) will link to
when you click
through
secondBoard string The board to False ListMyBoards
(Board to move the pin
move pin to
to)

1873 | P a g e
 Pinterest

Returns:
Type:PinResponse
Description: PinResponse

GetCurrentUser
Summary: Get current user
Description: Get current user

Syntax:
Pinterest.GetCurrentUser ()

Returns:
Type:UserResponse
Description: UserResponse

ListMyFollowers
Summary: List my followers
Description: List my followers

Syntax:
Pinterest.ListMyFollowers ()

Returns:
Type:UserResponse
Description: UserResponse

ListMyFollowings
Summary: List my followings

1874 | P a g e
 Pinterest

Description: List my followings

Syntax:
Pinterest.ListMyFollowings ()

Returns:
Type:UserResponse
Description: UserResponse

Triggers:
Trigger OnPinAddedToFollowedBoard
Summary: When pin is added to followed board
Description: When pin is added to followed board

Syntax:
Pinterest.OnPinAddedToFollowedBoard (string board)

Parameters:
Name Type Summary Required Related Action
board string Board True ListFollowBoards
(Board)

Returns:
Type:PinResponse
Description: PinResponse

Trigger OnPinAddedToMyBoard
Summary: When pin is added to my board
Description: When pin is added to my board
1875 | P a g e
 Pinterest

Syntax:
Pinterest.OnPinAddedToMyBoard (string board)

Parameters:
Name Type Summary Required Related
Action
board string Board True ListMyBoards
(Board)

Returns:
Type:PinResponse
Description: PinResponse

Trigger OnSomeoneFollowsMe
Summary: When someone follows me
Description: When someone follows me

Syntax:
Pinterest.OnSomeoneFollowsMe ()

Returns:
Type:UserResponse
Description: UserResponse

1876 | P a g e
 Pinterest

BoardResponse
Summary:
Description: BoardResponse

Properties:
Name Type Summary
data array of Board Data
(BoardResponseData)
Board Data

1877 | P a g e
 Pinterest

BoardResponseData
Summary:
Description: BoardResponseData

Properties:
Name Type Summary
url string Url
Url
id string Id
Id
name string Name
Name

1878 | P a g e
 Pinterest

PinResponse
Summary:
Description: PinResponse

Properties:
Name Type Summary
data array of (PinResponseData) Pin Data
Pin Data

1879 | P a g e
 Pinterest

PinResponseData
Summary:
Description: PinResponseData

Properties:
Name Type Summary
url string Url
Url
note string Note
Note
link string Link
Link
id string Id
Id

1880 | P a g e
 Pinterest

UserResponse
Summary:
Description: UserResponse

Properties:
Name Type Summary
data array of User Data
(UserResponseData)
User Data
page UserResponsePage UserResponsePage

1881 | P a g e
 Pinterest

UserResponseData
Summary:
Description: UserResponseData

Properties:
Name Type Summary
url string Url
Url
first_name string First name
First name
last_name string Last Name
Last Name
id string User Id
Id

1882 | P a g e
 Pinterest

UserResponsePage
Summary:
Description: UserResponsePage

Properties:
Name Type Summary
cursor string Cursor
Cursor
next string Next
Next

1883 | P a g e
 Pipedrive

Pipedrive
Pipedrive is a CRM & pipeline management tool that helps you focus on
actions that matter.

Status: Preview Tier: Premium Version: 1.0.0

Actions:
Name Summary
ListPersons () List persons
ListOrganizations () List organizations
ListDeals () List deals
AddDeal (AddDealRequest Add deal
body)
GetDeal (integer dealId) Get deal by id
UpdateDealStage (integer Update deal stage
dealId,
UpdateDealStageRequest
body)
UpdateDealStatus (integer Update deal status
dealId,
UpdateDealStatusRequest
body)
AddActivity Add activity
(AddActivityRequest body)
ListActivityTypes () List activity types

Triggers:
Name Summary

1884 | P a g e
 Pipedrive

TrigNewActivity () When a new activity is added

TrigNewDeal () When a new deal is added

Objects:
Name Summary
ActivityResponse
AddActivityRequest
AddDealRequest
DealResponse
ListActivityTypesResponse
ListDealsResponse
ListOrganizationsResponse
ListPersonsResponse
UpdateDealStageRequest
UpdateDealStatusRequest

Actions:
ListPersons
Summary: List persons
Description: List persons

Syntax:
Pipedrive.ListPersons ()

Returns:
Type:ListPersonsResponse

1885 | P a g e
 Pipedrive

ListOrganizations
Summary: List organizations
Description: List organizations

Syntax:
Pipedrive.ListOrganizations ()

Returns:
Type:ListOrganizationsResponse

ListDeals
Summary: List deals
Description: List deals

Syntax:
Pipedrive.ListDeals ()

Returns:
Type:ListDealsResponse

AddDeal
Summary: Add deal
Description: This operation creates a new deal for the authorized account.

Syntax:
Pipedrive.AddDeal (AddDealRequest body)

Parameters:

1886 | P a g e
 Pipedrive

Name Type Summary Required Related

Action
body AddDealRequest True

Returns:
Type:DealResponse
Description: data

GetDeal
Summary: Get deal by id
Description: This operation retrieves all details of an existing deal, given its id.

Syntax:
Pipedrive.GetDeal (integer dealId)

Parameters:
Name Type Summary Required Related
Action
dealId integer Deal True ListDeals
(Deal Id)

Returns:
Type:DealResponse
Description: data

UpdateDealStage
Summary: Update deal stage

1887 | P a g e
 Pipedrive

Description: This operation is used to update the stage associated with a deal, given its
id.

Syntax:
Pipedrive.UpdateDealStage (integer dealId,
UpdateDealStageRequest body)

Parameters:
Name Type Summary Required Related
Action
dealId integer Deal True ListDeals
(Deal Id)
body UpdateDealStageRequest True

Returns:
Type:DealResponse
Description: data

UpdateDealStatus
Summary: Update deal status
Description: This operation is used to update the status associated with a deal, given
its id.

Syntax:
Pipedrive.UpdateDealStatus (integer dealId,
UpdateDealStatusRequest body)

Parameters:

1888 | P a g e
 Pipedrive

Name Type Summary Required Related

Action
dealId integer Deal True ListDeals
(Deal Id)
body UpdateDealStatusRequest True

Returns:
Type:DealResponse
Description: data

AddActivity
Summary: Add activity
Description: This operation is used to create a new activity for the authorized account.

Syntax:
Pipedrive.AddActivity (AddActivityRequest body)

Parameters:
Name Type Summary Required Related
Action
body AddActivityRequest True

Returns:
Type:ActivityResponse
Description: data

1889 | P a g e
 Pipedrive

ListActivityTypes
Summary: List activity types
Description: List activity types

Syntax:
Pipedrive.ListActivityTypes ()

Returns:
Type:ListActivityTypesResponse

Triggers:
Trigger TrigNewActivity
Summary: When a new activity is added
Description: Triggers when a new activity is added to the authorized account.

Syntax:
Pipedrive.TrigNewActivity ()

Returns:
Type:array of (ActivityResponse)
Description: data

Trigger TrigNewDeal
Summary: When a new deal is added
Description: Triggers when a new deal is added to the authorized account.

Syntax:
Pipedrive.TrigNewDeal ()

1890 | P a g e
 Pipedrive

Returns:
Type:array of (DealResponse)
Description: data

1891 | P a g e
 Pipedrive

ActivityResponse
Summary:
Description: data

Properties:
Name Type Summary
id integer(int32) Unique id of the activity.
Activity Id
user_id integer(int32) Id of the user whom the
User Id activity is assigned to.
done boolean 0 = Not done, 1 = Done
Is Done
type string Type of the activity.
Type
due_date string YYYY-MM-DD
Due Date
due_time string HH:MM
Due Time
duration string HH:MM
Duration
subject string Subject of the activity.
Subject
deal_id integer(int32) Id of deal the activity is
Deal Id associated with.
deal_title string Title of deal the activity is
Deal Title associated with.
org_id integer(int32) Id of organization the
Organization Id activity is associated with.

1892 | P a g e
 Pipedrive

org_name string Name of organization the

Organization Name activity is associated with.
person_id integer(int32) Id of person the activity is
Contact Id associated with.
person_name string Id of person the activity is
Contact Name associated with
add_time string(date-time) yyyy-MM-
Created Date-Time ddTHH:mm:ss.fffZ
update_time string(date-time) yyyy-MM-
Updates Date-Time ddTHH:mm:ss.fffZ
marked_as_done_time string(date-time) yyyy-MM-
Completed Date-Time ddTHH:mm:ss.fffZ
gcal_event_id string Id of the google calendar
Google Calendar Event Id event.
google_calendar_id string Id of the google calendar.
Google Calendar Id
note string Note of the activity (HTML
Note format).
assigned_to_user_id integer(int32) User id of user whom the
Assigned to activity is assigned to.
created_by_user_id integer(int32) User id of user that
Created by created the activity.
owner_name string Name of the activity
Owner Name owner.

1893 | P a g e
 Pipedrive

AddActivityRequest
Summary:
Description:

Properties:
Name Type Summary
type string Activity type.
Type
subject string Subject of the activity.
Subject
due_date string YYYY-MM-DD
Due Date
due_time string HH:MM
Due Time
duration string HH:MM
Duration
note string
Notes
user_id integer(int32) Id of the user whom the
Assigned to activity will be assigned to.
deal_id integer(int32) ID of deal the activity will
Deal Id be associated with.
person_id integer(int32) Id of person the activity
Contact Id will be associated with.
org_id integer(int32) ID of the organization the
Organization Id activity will be associated
with.

1894 | P a g e
 Pipedrive

AddDealRequest
Summary:
Description:

Properties:
Name Type Summary
title string Title of the deal.
Title
stage_id string Stage of the deal. Values:
Stage Id [Lead In, Contact Made,
Demo Scheduled, Proposal
Made, Negotiations
Started]
status string Status of the deal. Values:
Status [Open, Won, Lost,
Deleted]
value integer(int32) Monetary value of the
Value deal.
currency string Currency of the deal.
Currency Values: [Afghanistan
Afghani, Albanian Lek,
Algerian Dinar, Angolan
Kwanza, Argentine Peso,
Armenian Dram, Aruban
Guilder, Australian Dollar,
Azerbaijan New Manat,
Azerbaijanian Manat,
Bahamian Dollar, Bahraini
Dinar, Bangladesh Taka,

1895 | P a g e
 Pipedrive

Barbados Dollar,
Belarussian Ruble, Belize
Dollar, Bermudian Dollar,
Bhutan Ngultrum, Bitcoin,
Bolivian Boliviano, Bosnia
and Herzegovina
Convertible Marks,
Botswana Pula, Brazilian
Real, Brunei Dollar,
Bulgarian Lev, Burundi
Franc, Cambodia Riel,
Canadian Dollar, Cape
Verde Escudo, Cayman
Islands Dollar, CFA Franc
BCEAO, CFA Franc BEAC,
CFP Franc, Chilean Peso,
Chilean Unidad de
Fomento, Chinese Yuan
Renminbi, Colombian
Peso, Comoro Franc, Costa
Rican Colon, Croatian
Kuna, Cuban Peso, Cyprus
Pound, Czech Koruna,
Danish Krone, Djibouti
Franc, Dominican Peso,
East Caribbean Dollar,
Egyptian Pound, El
Salvador Colon, Eritrea
Nafka, Estonian Kroon,

1896 | P a g e
 Pipedrive

Ethiopian Birr, Euro,

Falkland Islands Pound, Fiji
Dollar, Franc Congolais,
Gambian Dalasi, Georgian
Lari, Ghana Cedi,
Ghanaian Cedi, Gibraltar
Pound, Gold, Guatemala
Quetzal, Guinea Franc,
Guyana Dollar, Haiti
Gourde, Honduras
Lempira, Hong Kong
Dollar, Hungarian Forint,
Iceland Krona, Indian
Rupee, Indonesian Rupiah,
Iranian Rial, Iraqi Dinar,
Jamaican Dollar, Japanese
Yen, Jordanian Dinar,
Kazakhstan Tenge, Kenyan
Shilling, Korean Won,
Kuwaiti Dinar, Kyrgyzstan
Som, Lao Kip, Latvian Lats,
Lebanese Pound, Lesotho
Loti, Liberian Dollar,
Libyan Dinar, Lithuanian
Litas, Macau Pataca,
Macedonian Denar,
Malagasy Ariary, Malawi
Kwacha, Malaysian
Ringgit, Maldives Rufiyaa,

1897 | P a g e
 Pipedrive

Maltese Lira, Mauritania

Ouguiya, Mauritius Rupee,
Mexican Peso, Moldovan
Leu, Mongolian Tugrik,
Moroccan Dirham,
Mozambican Metical,
Mozambique Metical,
Myanmar Kyat, Namibia
Dollar, Nepalese Rupee,
Netherlands Antillian
Guilder, New Belarusian
Ruble, New Israeli Shekel,
New Taiwan Dollar, New
Zealand Dollar, Nicaragua
Cordoba Oro, Nigerian
Naira, North Korean Won,
Norwegian Krone,
Pakistan Rupee,
Palladium, Panama
Balboa, Papua New
Guinea Kina, Paraguayan
Guarani, Peruvian Nuevo
Sol, Peso Uruguayo,
Philippine Peso, Platinum,
Polish Zloty, Pound
Sterling, Qatari Rial, Rial
Omani, Romanian Leu,
Russian Ruble, Rwanda
Franc, Samoa Tala, São

1898 | P a g e
 Pipedrive

Tome and Principe Dobra,

Saudi Riyal, SDR (Special
Drawing Rights), Serbian
Dinar (CSD), Serbian Dinar
(RSD), Seychelles Rupee,
Sierra Leone Leone, Silver,
Singapore Dollar, Slovak
Koruna, Slovenian Tolar,
Solomon Islands Dollar,
Somali Shilling, South
African Rand, Sri Lanka
Rupee, St Helena Pound,
Sudanese Dinar, Sudanese
Pound, Surinam Dollar,
Swaziland Lilangeni,
Swedish Krona, Swiss
Franc, Syrian Pound, Tajik
Somoni, Tanzanian
Shilling, Thai Baht, Tonga
Pa'anga, Trinidad and
Tobago Dollar, Tunisian
Dinar, Turkish Lira,
Turkmenistan Manat,
Turkmenistani Manat, UAE
Dirham, Uganda Shilling,
Ukraine Hryvnia, US
Dollar, Uzbekistan Sum,
Vanuatu Vatu, Venezuelan
Bolivar, Venezuelan

1899 | P a g e
 Pipedrive

Bolívar, Vietnamese Dong,

Yemeni Rial, Zambian
Kwacha (ZMK), Zambian
Kwacha (ZMW), Zimbabwe
Dollar]
person_id string User id of person the deal
Contact Id is associated with.
org_id string Id of the organization
Organization Id associated with the deal.
expected_close_date string yyyy-MM-dd
Expected Close Date
visible_to string Owner, followers or entire
Visiblity company. Values: [Owner
and followers, Entire
company]
add_time string(date-time) yyyy-MM-
Created Date-Time ddTHH:mm:ss.fffZ
user_id integer(int32) Id of the deal owner.
User Id

1900 | P a g e
 Pipedrive

DealResponse
Summary:
Description: data

Properties:
Name Type Summary
id integer(int32) Id of the deal.
Deal Id
creator_user_id Creator_user_id
Creator
user_id User_id
User
person_id Person_id
Owner
org_id Org_id
Organization
status string Open, won, lost or
Status deleted.
title string Title of the deal.
Deal Title
value integer(int32) Monetary value of the
Deal Value deal.
currency string Currency associated with
Currency the deal value.
add_time string(date-time) yyyy-MM-
Created Date-Time ddTHH:mm:ss.fffZ
update_time string(date-time) yyyy-MM-
Updated Date-Time ddTHH:mm:ss.fffZ

1901 | P a g e
 Pipedrive

stage_id integer(int32) ID of stage the deal is

Stage Id placed in a pipeline.
stage_name string Name of stage the deal is
Stage Name placed in a pipeline
stage_change_time string(date-time) yyyy-MM-
Stage Uodated Date- ddTHH:mm:ss.fffZ
Time
active boolean True if the deal is active.
Is Active
deleted boolean True if the deal has been
Is Deleted deleted.
next_activity_date string yyyy-MM-dd
Next Activity Date
next_activity_time string yyyy-MM-
Next Activity Time ddTHH:mm:ss.fffZ
next_activity_id integer(int32) Id of the next activity.
Next Activity Id
last_activity_id string Id of the last activity.
Last Activity Id
last_activity_date string yyyy-MM-dd
Last Activity Date
lost_reason string Message about why the
Lost Reason deal was lost (to be used
when status=lost).
visible_to string Owner, followers or
Visiblity entire company.
close_time string(date-time) yyyy-MM-
Closed Date-Time ddTHH:mm:ss.fffZ

1902 | P a g e
 Pipedrive

pipeline_id integer(int32) Id of pipeline the deal is

Pipeline Id associated with.
products_count integer(int32) Number of products
Products Count associated with the deal.
files_count integer(int32) Number of files
Files Count associated with the deal.
notes_count integer(int32) Number of notes
Notes Count associated with the deal.
followers_count integer(int32) Number of followers
Followers Count associated with the deal.
email_messages_count integer(int32) Number of email
Email Message Count messages associated with
the deal.
activities_count integer(int32) Number of activities
Activities Count associated with the deal.
done_activities_count integer(int32) Number of done activities
Done Activities Count associated with the deal.
undone_activities_count integer(int32) Number of undone
Undone Activities Count activitie associated with
the deals.
reference_activities_count integer(int32) Number of referenced
Referenced Activities activities associated with
Count the deal.
participants_count integer(int32) Number of participants
Participants Count associated with the deal.
expected_close_date string yyyy-MM-dd
Expected Close Date
next_activity_subject string Subject of next activity
Next Activity Subject associated with the deal.

1903 | P a g e
 Pipedrive

next_activity_type string Type of next activity

Next Activity Type associated with the deal.
next_activity_duration string Duration of next activity
Next Activity Duration associated with the deal.
next_activity_note string Notes for next activity
Next Activity Note associated with the deal

Creator_user_id
Summary: Creator
Description:

Properties:
Name Type Summary
id integer(int32) Id of the deal creator.
Id
name string Name of the deal creator.
Name
email string Email of the deal creator.
Email

User_id
Summary: User
Description:

Properties:
Name Type Summary
id integer(int32) Id of the deal owner.
Id
name string Name of the deal owner.

1904 | P a g e
 Pipedrive

Name
email string Email of the deal owner.
Email

Person_id
Summary: Owner
Description:

Properties:
Name Type Summary
name string Name of the person
Name associated with the deal.
value integer(int32) Id of the person
Id associated with the deal.

Org_id
Summary: Organization
Description:

Properties:
Name Type Summary
name string Name of the organization
Name associated with the deal.
value integer(int32) Id of the organization
Id associated with the deal.

1905 | P a g e
 Pipedrive

ListActivityTypesResponse
Summary:
Description:

Properties:
Name Type Summary
success boolean success
success
data array of (DataItem) data
data

DataItem
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) id
id
name string name
name

1906 | P a g e
 Pipedrive

ListDealsResponse
Summary:
Description:

Properties:
Name Type Summary
data array of (DataItem) data

DataItem
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) id
id
title string title
title

1907 | P a g e
 Pipedrive

ListOrganizationsResponse
Summary:
Description:

Properties:
Name Type Summary
data array of (DataItem) data

DataItem
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) id
id
name string title
title

1908 | P a g e
 Pipedrive

ListPersonsResponse
Summary:
Description:

Properties:
Name Type Summary
data array of (DataItem) data

DataItem
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) id
id
name string title
title

1909 | P a g e
 Pipedrive

UpdateDealStageRequest
Summary:
Description:

Properties:
Name Type Summary
stage_id string Stage of the deal. Values:
Stage Id [Lead In, Contact Made,
Demo Scheduled,
Proposal Made,
Negotiations Started]
expected_close_date string yyyy-MM-dd
Expected Close Date

1910 | P a g e
 Pipedrive

UpdateDealStatusRequest
Summary:
Description:

Properties:
Name Type Summary
status string Status of the deal. Values:
Status [open, won, lost, deleted]
lost_reason string Message about why the
Lost Reason deal was lost.

1911 | P a g e
 Pivotal Tracker

Pivotal Tracker
Pivotal Tracker is purpose-built to make it easy for you to convert an idea into
a set of stories that you can prioritize, assign, and manage through
completion.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
CreateStory (integer Create a story
projectId,
CreateStoryParameterBody
body)
ListProjects () List projects
GetStory (integer projectId, Get a story
string storyId)
UpdateStory (integer Update a story
projectId, string storyId,
UpdateStoryParameterBody
body)
DeleteStory (integer Delete a story
projectId, string storyId)

Triggers:
Name Summary
TrigStoryCreated (integer When a new story is created
projectId)

1912 | P a g e
 Pivotal Tracker

TrigStoryCompleted (integer When a story is completed

projectId, [internal]string
with_state)
TrigStoryUpdated (integer When a story is updated
projectId)

Objects:
Name Summary
CreateStoryParameterBody
ListProjectsResponseItem
Story_Response
UpdateStoryParameterBody

Actions:
CreateStory
Summary: Create a story
Description: This operation is used to create a new story.

Syntax:
PivotalTracker.CreateStory (integer projectId,
CreateStoryParameterBody body)

Parameters:
Name Type Summary Required Related
Action
projectId integer Pick a True ListProjects
(Project Id) project.
body CreateStoryParameterBody True

1913 | P a g e
 Pivotal Tracker

Returns:
Type:Story_Response

ListProjects
Summary: List projects
Description: List all projects for the current user.

Syntax:
PivotalTracker.ListProjects ()

Returns:
Type:array of (ListProjectsResponseItem)

GetStory
Summary: Get a story
Description: This operation retrieves all information about a story, given its id.

Syntax:
PivotalTracker.GetStory (integer projectId, string storyId)

Parameters:
Name Type Summary Required Related
Action
projectId integer Pick a project. True ListProjects
(Project Id)
storyId string True

1914 | P a g e
 Pivotal Tracker

(Story Id)

Returns:
Type:Story_Response

UpdateStory
Summary: Update a story
Description: This operation is used to update the details of a story, given its id.

Syntax:
PivotalTracker.UpdateStory (integer projectId, string storyId,
UpdateStoryParameterBody body)

Parameters:
Name Type Summary Required Related
Action
projectId integer Pick a True ListProjects
(Project Id) project.
storyId string True
(Story Id)
body UpdateStoryParameterBody True

Returns:
Type:Story_Response

DeleteStory
Summary: Delete a story
Description: Deletes the specified story.

1915 | P a g e
 Pivotal Tracker

Syntax:
PivotalTracker.DeleteStory (integer projectId, string storyId)

Parameters:
Name Type Summary Required Related
Action
projectId integer Pick a project. True ListProjects
(Project Id)
storyId string True
(Story Id)

Returns:
Type:string

Triggers:
Trigger TrigStoryCreated
Summary: When a new story is created
Description: Triggers when a new story is added to the given project.

Syntax:
PivotalTracker.TrigStoryCreated (integer projectId)

Parameters:
Name Type Summary Required Related
Action
projectId integer Pick a project. True ListProjects
(Project Id)

1916 | P a g e
 Pivotal Tracker

Returns:
Type:array of (Story_Response)

Trigger TrigStoryCompleted
Summary: When a story is completed
Description: Triggers when an existing story is completed in the given project.

Syntax:
PivotalTracker.TrigStoryCompleted (integer projectId,
[internal]string with_state)

Parameters:
Name Type Summary Required Related
Action
projectId integer Pick a project. True ListProjects
(Project Id)
with_state string True

Returns:
Type:array of (Story_Response)

Trigger TrigStoryUpdated
Summary: When a story is updated
Description: Triggers when a story is created or the details of an existing story are
updated in the given project.

Syntax:
PivotalTracker.TrigStoryUpdated (integer projectId)

1917 | P a g e
 Pivotal Tracker

Parameters:
Name Type Summary Required Related
Action
projectId integer Pick a project. True ListProjects
(Project Id)

Returns:
Type:array of (Story_Response)

1918 | P a g e
 Pivotal Tracker

CreateStoryParameterBody
Summary:
Description:

Properties:
Name Type Summary
name string
Title
description string
Description
story_type string Pick a story type. Values:
Type [feature, bug, chore,
release]
current_state string Pick a completion state.
State Values: [accepted,
delivered, finished,
started, rejected, planned,
unstarted, unscheduled]
estimate integer(int32) Point value of the story.
Points
accepted_at string yyyy-MM-
Acceptance Date-Time ddTHH:mm:ss.fffZ
deadline string yyyy-MM-
Due Date-Time ddTHH:mm:ss.fffZ
requested_by_id integer(int32) User id of the person who
Requestor Id requested the story.

1919 | P a g e
 Pivotal Tracker

ListProjectsResponseItem
Summary:
Description:

Properties:
Name Type Summary
account_id integer(int32)
Account Id
created_at string(date-time) yyyy-MM-
Created Date/Time ddTHH:mm:ss.fffZ
current_iteration_number integer(int32)
Current Iteration
Number
enable_following boolean Allow users to follow
Enable Following stories and epics.
enable_incoming_emails boolean Allow incoming email
Enable Incoming Emails responses and convert
them to comments.
enable_tasks boolean Allow individual tasks to
Enable Tasks be created and managed
within each story in the
project.
id integer(int32)
Project Id
initial_velocity integer(int32)
Initial Velocity
iteration_length integer(int32) The number of weeks in
Iteration Length an iteration.
name string

1920 | P a g e
 Pivotal Tracker

Project Name
point_scale string
Point Scale
project_type string
Project Type
public boolean
Is Public
start_time string(date-time) yyyy-MM-
Start Date/Time ddTHH:mm:ss.fffZ
updated_at string(date-time) yyyy-MM-
Update Date/Time ddTHH:mm:ss.fffZ
velocity_averaged_over integer(int32) The number of iterations
Velocity Averaged Over that should be used when
averaging the number of
points of Done stories in
order to compute the
project's velocity.
version integer(int32)
Version
week_start_day string The day in the week the
Week Start Day project's iterations are to
start on.

1921 | P a g e
 Pivotal Tracker

Story_Response
Summary:
Description:

Properties:
Name Type Summary
accepted_at string(date-time) yyyy-MM-
Acceptance Date-Time ddTHH:mm:ss.fffZ
created_at string(date-time) yyyy-MM-
Created Date-Time ddTHH:mm:ss.fffZ
current_state string Story's state of
State completion.
description string In-depth explanation of
Description the story requirements.
estimate integer(int32) Point value of the story
Points (feature story type only).
id integer(int32) The Id of the story.
Story Id
labels array of (LabelsItem) Story labels.
Labels
name string Story name.
Title
owner_ids array of (string)

project_id integer(int32) The Id of the project.

Project Id
requested_by_id integer(int32) The id of the person who
Requestor Id requested the story.
story_type string Type of story.

1922 | P a g e
 Pivotal Tracker

Story Type
updated_at string(date-time) yyyy-MM-
Updated Date-Time ddTHH:mm:ss.fffZ
url string The URL of the story.
URL

LabelsItem
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) The Id of the label.
Label Id
name string The name of the label.
Label Name

1923 | P a g e
 Pivotal Tracker

UpdateStoryParameterBody
Summary:
Description:

Properties:
Name Type Summary
name string
Title
description string
Description
story_type string Pick the story type.
Type Values: [feature, bug,
chore, release]
current_state string Pick the completion state.
State Values: [accepted,
delivered, finished,
started, rejected, planned,
unstarted, unscheduled]
estimate integer(int32) Point value of the story.
Points
accepted_at string yyyy-MM-
Acceptance Date-Time ddTHH:mm:ss.fffZ
deadline string yyyy-MM-
Due Date-Time ddTHH:mm:ss.fffZ
requested_by_id integer(int32) User id of the person who
Requestor Id requested the story.

1924 | P a g e
 Power BI

Power BI
Power BI is a suite of business analytics tools to analyze data and share
insights. Connect to get easy access to the data in your Power BI dashboards,
reports and datasets.

Status: Preview Tier: Standard Version: v1

Actions:
Name Summary
GetAlerts () Get alerts from Power BI
AddRows (string groupid, Add rows to a dataset
string datasetid, string
tablename, [Optional]Payload
Payload)
ListGroups ()
ListDatasets (string groupid)
ListTables (string groupid,
string datasetid)
GetColumns (string groupid,
string datasetid, string
tablename)

Triggers:
Name Summary
CheckAlertStatus (string When a data driven alert is triggered
alertId)

1925 | P a g e
 Power BI

Objects:
Name Summary
Alert
Columns
Datasets
EvaluatedAlert
Groups
Payload
Tables

Actions:
GetAlerts
Summary: Get alerts from Power BI
Description: Return a list of alerts for a signed in user.

Syntax:
PowerBI.GetAlerts ()

Returns:
Type:array of (Alert)

AddRows
Summary: Add rows to a dataset
Description: Use Power BI REST API to add rows to a dataset.

Syntax:
PowerBI.AddRows (string groupid, string datasetid, string
tablename, [Optional]Payload Payload)

1926 | P a g e
 Power BI

Parameters:
Name Type Summary Required Related
Action
groupid string Workspace ID True ListGroups
(Workspace)
datasetid string Dataset ID True ListDatasets
(Dataset)
tablename string Table Name True ListTables
(Table)
Payload Payload False

Returns:

ListGroups
Summary:
Description: Get Groups for Power BI.

Syntax:
PowerBI.ListGroups ()

Returns:
Type:Groups

ListDatasets
Summary:
Description: Get datasets for Power BI group.

1927 | P a g e
 Power BI

Syntax:
PowerBI.ListDatasets (string groupid)

Parameters:
Name Type Summary Required Related
Action
groupid string Workspace ID True ListGroups
(Workspace)

Returns:
Type:Datasets

ListTables
Summary:
Description: Get tables for Power BI dataset.

Syntax:
PowerBI.ListTables (string groupid, string datasetid)

Parameters:
Name Type Summary Required Related
Action
groupid string Workspace ID True ListGroups
(Workspace)
datasetid string Dataset ID True ListDatasets
(Dataset)

Returns:
Type:Tables

1928 | P a g e
 Power BI

GetColumns
Summary:
Description: Get columns for Power BI dataset table.

Syntax:
PowerBI.GetColumns (string groupid, string datasetid, string
tablename)

Parameters:
Name Type Summary Required Related
Action
groupid string Workspace ID True ListGroups
(Workspace)
datasetid string Dataset ID True ListDatasets
(Dataset)
tablename string Table Name True ListTables
(Table)

Returns:
Type:Columns

Triggers:
Trigger CheckAlertStatus
Summary: When a data driven alert is triggered
Description: Return the status of an alert from Power BI.

Syntax:
PowerBI.CheckAlertStatus (string alertId)

1929 | P a g e
 Power BI

Parameters:
Name Type Summary Required Related
Action
alertId string Choose an alert. True GetAlerts
(Alert Id)

Returns:
Type:EvaluatedAlert

1930 | P a g e
 Power BI

Alert
Summary:
Description:

Properties:
Name Type Summary
alertId string The ID of the alert.
Alert ID
alertTitle string The title of the alert.
Alert title
groupId string The ID of the group.
Group ID

1931 | P a g e
 Power BI

Columns
Summary:
Description:

Properties:
Name Type Summary
schema Schema

Schema
Summary:
Description:

Properties:
Name Type Summary

1932 | P a g e
 Power BI

Datasets
Summary:
Description:

Properties:
Name Type Summary
value array of (ValueItem)

ValueItem
Summary:
Description:

Properties:
Name Type Summary
id string The ID of the dataset.
Dataset ID
name string The display name of the
Dataset name dataset.
addRowsAPIEnabled boolean Whether or not this
Add Rows API Enabled dataset supports
programmatic adding of
rows.

1933 | P a g e
 Power BI

EvaluatedAlert
Summary:
Description:

Properties:
Name Type Summary
alertTitle string The title of the alert.
Alert title
alertThreshold number The threshold at which
Alert threshold the alert is triggered.
isAlertTriggered boolean Whether or not the alert
Is alert triggered was triggered.
tileUrl string URL linking to the
Tile URL dashboard tile where the
alert is set up.
tileValue number The value of the tile.
Tile value

1934 | P a g e
 Power BI

Groups
Summary:
Description:

Properties:
Name Type Summary
value array of (ValueItem)

ValueItem
Summary:
Description:

Properties:
Name Type Summary
id string The ID of the group.
Group ID
name string The display name of the
Group name group.

1935 | P a g e
 Power BI

Payload
Summary:
Description:

Properties:
Name Type Summary

1936 | P a g e
 Power BI

Tables
Summary:
Description:

Properties:
Name Type Summary
value array of (ValueItem)

ValueItem
Summary:
Description:

Properties:
Name Type Summary
name string The display name of the
Table name table.

1937 | P a g e
 PowerApps Notification

PowerApps Notification
Send push notifications to apps created with PowerApps. Trigger them from
Flows or other apps.

Status: Preview Tier: Premium Version: 1.0.0

Actions:
Name Summary
SendPushNotification
(NotificationPayLoad payload)

Triggers:
Name Summary

Objects:
Name Summary
NotificationPayLoad

Actions:
SendPushNotification
Summary:
Description: Send a push notification to the app specified in the Push Notification
connection setup.

Syntax:
PowerAppsNotification.SendPushNotification (NotificationPayLoad
payload)

1938 | P a g e
 PowerApps Notification

Parameters:
Name Type Summary Required Related
Action
payload NotificationPayLoad True

Returns:

1939 | P a g e
 PowerApps Notification

NotificationPayLoad
Summary:
Description:

Properties:
Name Type Summary
recipients array of (string) List of user emails or user
Recipients principle identifiers.
message string Message body for the
Message push notification.
openApp boolean Whether to open or not
Open App the app when user taps on
the push notification.
params Params Key value parameters to
Parameters pass with the notification.

Params
Summary: Parameters
Description: Key value parameters to pass with the notification.

Properties:
Name Type Summary

1940 | P a g e
 Powerflows

Powerflows

Status: Tier: Standard Version: 2015-08-01-

preview

Actions:
Name Summary
Workflow_Get (string api-
version)
WorkflowTriggers_List (string
api-version, [Optional]integer
$top)
WorkflowTriggers_Get (string
triggerName, string api-
version)
WorkflowTriggers_Run (string
triggerName, string api-
version)
WorkflowTriggerHistories_List
(string triggerName, string
api-version, [Optional]integer
$top)
WorkflowTriggerHistories_Get
(string triggerName, string
historyName, string api-
version)

1941 | P a g e
 Powerflows

WorkflowRuns_List (string
api-version, [Optional]integer
$top, [Optional]string $filter)
WorkflowRuns_Get (string
runName, string api-version)
WorkflowRunActions_List
(string runName, string api-
version, [Optional]integer
$top, [Optional]string $filter)
WorkflowRunActions_Get
(string runName, string
actionName, string api-
version)

Triggers:
Name Summary

Objects:
Name Summary
ContentHash
ContentLink
Object
ResourceReference
Workflow
WorkflowProperties
WorkflowRun
WorkflowRunAction
WorkflowRunActionListResult

1942 | P a g e
 Powerflows

WorkflowRunActionProperties
WorkflowRunListResult
WorkflowRunProperties
WorkflowTrigger
WorkflowTriggerHistory
WorkflowTriggerHistoryListResult
WorkflowTriggerHistoryProperties
WorkflowTriggerListResult
WorkflowTriggerProperties
WorkflowTriggerRecurrence

Actions:
Workflow_Get
Summary:
Description: Gets a workflow.

Syntax:
Powerflows.Workflow_Get (string api-version)

Parameters:
Name Type Summary Required Related
Action
api-version string The power flow True
API version.

Returns:
Type:Workflow

1943 | P a g e
 Powerflows

WorkflowTriggers_List
Summary:
Description: Gets a list of power flow triggers.

Syntax:
Powerflows.WorkflowTriggers_List (string api-version,
[Optional]integer $top)

Parameters:
Name Type Summary Required Related
Action
api-version string The power flow True
API version.
$top integer(int32) The number of False
items to be
included in the
result.

Returns:
Type:WorkflowTriggerListResult

WorkflowTriggers_Get
Summary:
Description: Gets a power flow trigger.

Syntax:
Powerflows.WorkflowTriggers_Get (string triggerName, string api-
version)

1944 | P a g e
 Powerflows

Parameters:
Name Type Summary Required Related
Action
triggerName string The power flow True
trigger name.
api-version string The power flow True
API version.

Returns:
Type:WorkflowTrigger

WorkflowTriggers_Run
Summary:
Description: Runs a power flow trigger.

Syntax:
Powerflows.WorkflowTriggers_Run (string triggerName, string api-
version)

Parameters:
Name Type Summary Required Related
Action
triggerName string The power flow True
trigger name.
api-version string The power flow True
API version.

Returns:

1945 | P a g e
 Powerflows

WorkflowTriggerHistories_List
Summary:
Description: Gets a list of power flow trigger histories.

Syntax:
Powerflows.WorkflowTriggerHistories_List (string triggerName,
string api-version, [Optional]integer $top)

Parameters:
Name Type Summary Required Related
Action
triggerName string The power flow True
trigger name.
api-version string The power flow True
API version.
$top integer(int32) The number of False
items to be
included in the
result.

Returns:
Type:WorkflowTriggerHistoryListResult

WorkflowTriggerHistories_Get
Summary:
Description: Gets a power flow trigger history.

Syntax:

1946 | P a g e
 Powerflows

Powerflows.WorkflowTriggerHistories_Get (string triggerName,

string historyName, string api-version)

Parameters:
Name Type Summary Required Related
Action
triggerName string The power flow True
trigger name.
historyName string The power flow True
trigger history
name.
api-version string The power flow True
API version.

Returns:
Type:WorkflowTriggerHistory

WorkflowRuns_List
Summary:
Description: Gets a list of power flow runs.

Syntax:
Powerflows.WorkflowRuns_List (string api-version,
[Optional]integer $top, [Optional]string $filter)

Parameters:
Name Type Summary Required Related
Action

1947 | P a g e
 Powerflows

api-version string The power flow True

API version.
$top integer(int32) The number of False
items to be
included in the
result.
$filter string The filter to False
apply on the
operation.

Returns:
Type:WorkflowRunListResult

WorkflowRuns_Get
Summary:
Description: Gets a power flow run.

Syntax:
Powerflows.WorkflowRuns_Get (string runName, string api-version)

Parameters:
Name Type Summary Required Related
Action
runName string The power flow True
run name.
api-version string The power flow True
API version.

Returns:

1948 | P a g e
 Powerflows

Type:WorkflowRun

WorkflowRunActions_List
Summary:
Description: Gets a list of power flow run actions.

Syntax:
Powerflows.WorkflowRunActions_List (string runName, string api-
version, [Optional]integer $top, [Optional]string $filter)

Parameters:
Name Type Summary Required Related
Action
runName string The power flow True
run name.
api-version string The power flow True
API version.
$top integer(int32) The number of False
items to be
included in the
result.
$filter string The filter to False
apply on the
operation.

Returns:
Type:WorkflowRunActionListResult

1949 | P a g e
 Powerflows

WorkflowRunActions_Get
Summary:
Description: Gets a power flow run action.

Syntax:
Powerflows.WorkflowRunActions_Get (string runName, string
actionName, string api-version)

Parameters:
Name Type Summary Required Related
Action
runName string The power flow True
run name.
actionName string The power flow True
run action name.
api-version string The power flow True
API version.

Returns:
Type:WorkflowRunAction

1950 | P a g e
 Powerflows

ContentHash
Summary:
Description:

Properties:
Name Type Summary
algorithm string Gets or sets the algorithm.

value string Gets or sets the value.

1951 | P a g e
 Powerflows

ContentLink
Summary:
Description:

Properties:
Name Type Summary
uri string Gets or sets the content
link URI.
contentVersion string Gets or sets the content
version.
contentSize integer(int64) Gets or sets the content
size.
contentHash ContentHash

metadata Object

1952 | P a g e
 Powerflows

Object
Summary:
Description:

Properties:
Name Type Summary

1953 | P a g e
 Powerflows

ResourceReference
Summary:
Description:

Properties:
Name Type Summary
id string Gets or sets the resource
id.

1954 | P a g e
 Powerflows

Workflow
Summary:
Description:

Properties:
Name Type Summary
properties WorkflowProperties

1955 | P a g e
 Powerflows

WorkflowProperties
Summary:
Description:

Properties:
Name Type Summary
state string Values: [NotSpecified,
Enabled, Disabled,
Deleted, Suspended]
definition Object

parameters Parameters Gets or sets the

parameters.

Parameters
Summary:
Description: Gets or sets the parameters.

Properties:
Name Type Summary

1956 | P a g e
 Powerflows

WorkflowRun
Summary:
Description:

Properties:
Name Type Summary
properties WorkflowRunProperties

1957 | P a g e
 Powerflows

WorkflowRunAction
Summary:
Description:

Properties:
Name Type Summary
properties WorkflowRunActionProperties

1958 | P a g e
 Powerflows

WorkflowRunActionListResult
Summary:
Description:

Properties:
Name Type Summary
value array of Gets or sets a list of
(WorkflowRunAction) power flow run actions.

nextLink string Gets or sets the URL to

get the next set of results.

1959 | P a g e
 Powerflows

WorkflowRunActionProperties
Summary:
Description:

Properties:
Name Type Summary
startTime string(date-time) Gets the start time.

endTime string(date-time) Gets the end time.

status string Values: [NotSpecified,

Paused, Running, Waiting,
Succeeded, Skipped,
Suspended, Cancelled,
Failed]
code string Gets the code.

error Object

trackingId string Gets the trackingId.

inputsLink ContentLink

outputsLink ContentLink

1960 | P a g e
 Powerflows

WorkflowRunListResult
Summary:
Description:

Properties:
Name Type Summary
value array of (WorkflowRun) Gets or sets a list of
power flow runs.
nextLink string Gets or sets the URL to
get the next set of results.

1961 | P a g e
 Powerflows

WorkflowRunProperties
Summary:
Description:

Properties:
Name Type Summary
startTime string(date-time) Gets the start time.

endTime string(date-time) Gets the end time.

status string Values: [NotSpecified,

Paused, Running, Waiting,
Succeeded, Skipped,
Suspended, Cancelled,
Failed]
code string Gets the code.

error Object

correlationId string Gets the trackingId.

1962 | P a g e
 Powerflows

WorkflowTrigger
Summary:
Description:

Properties:
Name Type Summary
properties WorkflowTriggerProperties

1963 | P a g e
 Powerflows

WorkflowTriggerHistory
Summary:
Description:

Properties:
Name Type Summary
properties WorkflowTriggerHistoryProperties

1964 | P a g e
 Powerflows

WorkflowTriggerHistoryListResult
Summary:
Description:

Properties:
Name Type Summary
value array of Gets or sets a list of
(WorkflowTriggerHistory) power flow trigger
histories.
nextLink string Gets or sets the URL to
get the next set of
results.

1965 | P a g e
 Powerflows

WorkflowTriggerHistoryProperties
Summary:
Description:

Properties:
Name Type Summary
startTime string(date-time) Gets the start time.

endTime string(date-time) Gets the end time.

status string Values: [NotSpecified,

Paused, Running, Waiting,
Succeeded, Skipped,
Suspended, Cancelled,
Failed]
code string Gets the code.

error Object

trackingId string Gets the tracking id.

inputsLink ContentLink

outputsLink ContentLink

fired boolean Gets a value indicating

whether trigger was fired.
run ResourceReference

1966 | P a g e
 Powerflows

1967 | P a g e
 Powerflows

WorkflowTriggerListResult
Summary:
Description:

Properties:
Name Type Summary
value array of (WorkflowTrigger) Gets or sets a list of
power flow triggers.
nextLink string Gets or sets the URL to
get the next set of results.

1968 | P a g e
 Powerflows

WorkflowTriggerProperties
Summary:
Description:

Properties:
Name Type Summary
createdTime string(date-time) Gets the created time.

changedTime string(date-time) Gets the changed time.

state string Values: [NotSpecified,

Enabled, Disabled,
Deleted, Suspended]
status string Values: [NotSpecified,
Paused, Running,
Waiting, Succeeded,
Skipped, Suspended,
Cancelled, Failed]
lastExecutionTime string(date-time) Gets the last execution
time.
nextExecutionTime string(date-time) Gets the next execution
time.
recurrence WorkflowTriggerRecurrence

workflow ResourceReference

1969 | P a g e
 Powerflows

WorkflowTriggerRecurrence
Summary:
Description:

Properties:
Name Type Summary
frequency string Values: [Second, Minute,
Hour, Day, Week, Month,
Year]
interval integer(int32) Gets or sets the interval.

startTime string(date-time) Gets or sets the start

time.
timeZone string Gets or sets the time
zone.

1970 | P a g e
 Project Online

Project Online
Project Online is a flexible online solution for project portfolio management
(PPM) and everyday work from Microsoft. Delivered through Office 365,
Project Online enables organizations to get started quickly with powerful
project management capabilities to plan, prioritize, and manage projects and project
portfolio investments-from almost anywhere on almost any device.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
ListProjects (string siteUrl) List projects
CreateProject (string siteUrl, Creates new project
NewProject proj)
CreateTask (string siteUrl, Creates new task
string project_id, NewTask
task)
CreateResource (string Create new resource
siteUrl, NewResource
resource)
ListTasks (string siteUrl, string Lists tasks
project_id)
CheckoutProject (string Checkout project
siteUrl, string project_id)
PublishProject (string siteUrl, Checkin and publish project
string project_id)

1971 | P a g e
 Project Online

Triggers:
Name Summary
OnNewProject (string siteUrl) When a new project is created
OnProjectPublished (string When a project is published
siteUrl)
OnNewResource (string When a new resource is created
siteUrl)
OnNewTask (string siteUrl) When a new task is created

Objects:
Name Summary
EnterpriseResource
NewProject
NewResource
NewTask
Object
Project
ProjectsWrapper
Task
TaskParameters
TasksWrapper
TriggerProject
TriggerProjectsWrapper
TriggerResource
TriggerResourcesWrapper
TriggerTask
TriggerTasksWrapper

1972 | P a g e
 Project Online

Actions:
ListProjects
Summary: List projects
Description: Lists the projects in your project online site

Syntax:
ProjectOnline.ListProjects (string siteUrl)

Parameters:
Name Type Summary Require Relate
d d
Action
siteUr string Ex: True
l (Root https://sample.sharepoint.com/teams/samplet
site eam
url of
your
projec
t site)

Returns:
Type:ProjectsWrapper
Description: Project online list projects response model

CreateProject
Summary: Creates new project
Description: Creates a new project in your project online site

Syntax:

1973 | P a g e
 Project Online

ProjectOnline.CreateProject (string siteUrl, NewProject proj)

Parameters:
Nam Type Summary Require Relate
e d d
Action
siteU string Ex: True
rl (Root site https://sample.sharepoint.com/teams/samp
url of leteam
your
project
site)
proj NewProje New project online server project True
ct

Returns:
Type:Project
Description: Project Online Project Model

CreateTask
Summary: Creates new task
Description: Creates a new task in you project

Syntax:
ProjectOnline.CreateTask (string siteUrl, string project_id,
NewTask task)

Parameters:

1974 | P a g e
 Project Online

Name Type Summary Require Relate

d d
Action
siteUrl string Ex: True
(Root https://sample.sharepoint.com/teams/samp
site url leteam
of your
project
site)
project_ string Unique id of the project to add the task to True
id (Projec
t id)
task NewTa New project online server task True
sk

Returns:
Type:NewTask
Description: New project online server task

CreateResource
Summary: Create new resource
Description: Creates an Enterprise Resources in your project online site

Syntax:
ProjectOnline.CreateResource (string siteUrl, NewResource
resource)

Parameters:

1975 | P a g e
 Project Online

Name Type Summary Requir Relate

ed d
Actio
n
siteUrl string Ex: True
(Root site https://sample.sharepoint.com/teams/sa
url of your mpleteam
project
site)
resour NewResou A new project online server resource True
ce rce

Returns:
Type:EnterpriseResource
Description: Project Online Enterprise Resource Model

ListTasks
Summary: Lists tasks
Description: Lists the published tasks in a project

Syntax:
ProjectOnline.ListTasks (string siteUrl, string project_id)

Parameters:
Name Type Summary Require Relate
d d
Action

1976 | P a g e
 Project Online

siteUrl string Ex: True

(Root https://sample.sharepoint.com/teams/sampl
site url eteam
of
your
projec
t site)
project_i string Unique id of the project to fetch tasks True
d (Proje
ct id)

Returns:
Type:TasksWrapper
Description: Project online list tasks response model

CheckoutProject
Summary: Checkout project
Description: Checks out an existing project in your site

Syntax:
ProjectOnline.CheckoutProject (string siteUrl, string
project_id)

Parameters:
Name Type Summary Require Relate
d d
Action

1977 | P a g e
 Project Online

siteUrl string Ex: True

(Root https://sample.sharepoint.com/teams/sampl
site url eteam
of
your
projec
t site)
project_i string Unique id of the project to checkout True
d (Proje
ct id)

Returns:
Type:Object

PublishProject
Summary: Checkin and publish project
Description: Check in and publish and existing project in your site

Syntax:
ProjectOnline.PublishProject (string siteUrl, string project_id)

Parameters:
Name Type Summary Require Relate
d d
Action
siteUrl string Ex: True
(Root https://sample.sharepoint.com/teams/sampl
site url eteam
of

1978 | P a g e
 Project Online

your
projec
t site)
project_i string Unique id of the project to checkin True
d (Proje
ct id)

Returns:
Type:Object

Triggers:
Trigger OnNewProject
Summary: When a new project is created
Description: Triggers a flow whenever a new project is created

Syntax:
ProjectOnline.OnNewProject (string siteUrl)

Parameters:
Name Type Summary Require Relate
d d
Action
siteUr string Ex: True
l (Root https://sample.sharepoint.com/teams/samplet
site eam
url of
your

1979 | P a g e
 Project Online

projec
t site)

Returns:
Type:TriggerProjectsWrapper
Description: Project online on new project response model

Trigger OnProjectPublished
Summary: When a project is published
Description: Triggers a flow whenever a project is published

Syntax:
ProjectOnline.OnProjectPublished (string siteUrl)

Parameters:
Name Type Summary Require Relate
d d
Action
siteUr string Ex: True
l (Root https://sample.sharepoint.com/teams/samplet
site eam
url of
your
projec
t site)

Returns:
Type:TriggerProjectsWrapper
Description: Project online on new project response model

1980 | P a g e
 Project Online

Trigger OnNewResource
Summary: When a new resource is created
Description: Triggers a new flow when a new resource is created

Syntax:
ProjectOnline.OnNewResource (string siteUrl)

Parameters:
Name Type Summary Require Relate
d d
Action
siteUr string Ex: True
l (Root https://sample.sharepoint.com/teams/samplet
site eam
url of
your
projec
t site)

Returns:
Type:TriggerResourcesWrapper
Description: Project online on new resource response model

Trigger OnNewTask
Summary: When a new task is created
Description: Triggers a flow when a new task is created

Syntax:

1981 | P a g e
 Project Online

ProjectOnline.OnNewTask (string siteUrl)

Parameters:
Name Type Summary Require Relate
d d
Action
siteUr string Ex: True
l (Root https://sample.sharepoint.com/teams/samplet
site eam
url of
your
projec
t site)

Returns:
Type:TriggerTasksWrapper
Description: Project online on new task response model

1982 | P a g e
 Project Online

EnterpriseResource
Summary:
Description: Project Online Enterprise Resource Model

Properties:
Name Type Summary
CanLevel boolean Can resource level
Can resource level
Code string Resource code
Resource code
CostAccrual integer(int32) Resource cost accrual
Resource cost accrual
CostCenter string Resource cost center
Resource cost center
Created string(date-time) Resource created time
Resource created time
DefaultBookingType integer(int32) Resource default booking
Default booking type type
Email string Resource email address
Email
ExternalId string Resource external id
External id
Group string Group which resource
Resource group belongs in
HireDate string(date-time) Hired date of the resource
Hire date
Id string Resource id
Resource id
Initials string Resource initials

1983 | P a g e
 Project Online

Resouce initials
IsActive boolean Is resource active
Is resource active
IsBudget boolean Is resource cost budgeted
Is budget
IsCheckedOut boolean Is resource checked out
Is checked out
IsGeneric boolean Is resource generic
Is generic
IsTeam boolean Is resource part of the
Is team team
MaterialLabel string Resource material label
Material label
Modified string(date-time) Time which the resource
Last modified is last modified
Name string Resource name
Resource name
Phonetics string Phonetic pronounciation
Resource phonetics of the resource
ResourceType integer(int32) Resource type
Resource type
TerminationDate string(date-time) Resource termination
Termination date date

1984 | P a g e
 Project Online

NewProject
Summary:
Description: New project online server project

Properties:
Name Type Summary
Name string Name of the new project
Project name to create
Description string Description of the new
Project description project to create
Start string(date-time) Start date of the new
Project start date project

1985 | P a g e
 Project Online

NewResource
Summary:
Description: A new project online server resource

Properties:
Name Type Summary
Name string The name of the new
Resource name resource to create
IsBudget boolean Is resource accounted for
Is resource in budget in the budget
IsGeneric boolean Is resource generic
Is resource generic
IsInactive boolean Is resource inactive
Is resource inactive

1986 | P a g e
 Project Online

NewTask
Summary:
Description: New project online server task

Properties:
Name Type Summary
parameters TaskParameters New project online server
task

1987 | P a g e
 Project Online

Object
Summary:
Description:

Properties:
Name Type Summary

1988 | P a g e
 Project Online

Project
Summary:
Description: Project Online Project Model

Properties:
Name Type Summary
ApprovedStart string(date-time) Approved project start
Approved start date time
ApprovedEnd string(date-time) Approved project end
Approved end date time
CheckedOutDate string(date-time) Time which the project is
Checked out date checked out
CheckOutDescription string Description which the
Checkout description project is checked out
with
CheckOutId string Id of the project
Checkout id checkout
CreatedDate string(date-time) Created date of the
Created date project
Id string Id of the project
Project id
IsCheckedOut boolean True if the project is
Is checked out currently checked out
ProjectLastPublishedDate string(date-time) Last published date of
Project last published the project
date
LastSavedDate string(date-time) Last date the project is
Last saved date saved

1989 | P a g e
 Project Online

OptimizerDecision integer(int32) Project optimizer

Optimizer decision decision number
PlannerDecision integer(int32) Project planner decision
Planner decision number
ProjectType integer(int32) The type of the project
Project type
Name string The name of the project
Project name
ProjectIdentifier string Project identifier
Project identifier
WinprojVersion string Project version
Win proj version

1990 | P a g e
 Project Online

ProjectsWrapper
Summary:
Description: Project online list projects response model

Properties:
Name Type Summary
value array of (Project) The list of projects
Returned projects returned

1991 | P a g e
 Project Online

Task
Summary:
Description: Project online server task

Properties:
Name Type Summary
Created string(date-time) The created date of the
Task created date task
Modified string(date-time) The last modified date of
Task last modified date the task
Start string(date-time) The start date of the task
Task start date
Finish string(date-time) The finished date of the
Task finish date task
Name string The name of the task
Task name
Id string The id of the task
Task id
Priority integer(int32) The priority level of the
Task priority task
PercentComplete integer(int32) Percent of task complete
Task percent complete
Notes string Description notes about
Task notes the task
Contact string Contact address for the
Task contact task

1992 | P a g e
 Project Online

TaskParameters
Summary:
Description: New project online server task

Properties:
Name Type Summary
Name string Name of the new task to
Task name create
Notes string Notes to put on the new
Task notes task
Start string(date-time) Start date of the task
Task start date
Duration string Duration of the task. For
Task duration example (1h, 2d, or 3w)

1993 | P a g e
 Project Online

TasksWrapper
Summary:
Description: Project online list tasks response model

Properties:
Name Type Summary
value array of (Task) The list of tasks returned
Returned projects

1994 | P a g e
 Project Online

TriggerProject
Summary:
Description: Project Online Project Model

Properties:
Name Type Summary
ProjectStartDate string(date-time) Approved project start
Project start date date
ProjectFinishDate string(date-time) Approved project end
Project end date date
ProjectCreatedDate string(date-time) Created date of the
Created date project
ProjectId string Id of the project
Project id
ProjectModifiedDate string(date-time) Last date the project is
Last modified date saved
ProjectType integer(int32) The type of the project
Project type
ProjectName string The name of the project
Project name
ProjectLastPublishedDate string(date-time) Last published date of
Project last published the project
date

1995 | P a g e
 Project Online

TriggerProjectsWrapper
Summary:
Description: Project online on new project response model

Properties:
Name Type Summary
value array of (TriggerProject) The list of trigger projects
Returned projects returned

1996 | P a g e
 Project Online

TriggerResource
Summary:
Description: Resource Online resource model

Properties:
Name Type Summary
ResourceId string Id of the new resource
Resource id
ResourceBaseCalendar string Base calendar type of
Resource base calendar the resource
ResourceBookingType integer(int32) Booking type of the
Resource booking type resource
ResourceCanLevel boolean Can the resource level
Can resource level
ResourceCostPerUse number(double) Cost per use of the
Resource cost per use resource
ResourceCreatedDate string(date-time) Create date of the
Resource create date resource
ResourceEarliestAvailableFrom string(date-time) Earliest availability date
Resource earliest of the resource
available from
ResourceEmail string Email address of the
Resource email resource
ResourceInitials string Initals of the resource
Resource initials
ResourceIsActive boolean Is the new resource
Is resource activew active
ResourceIsGeneric boolean Is the new resource
Is resource generic generic

1997 | P a g e
 Project Online

ResourceLatestAvailableTo string(date-time) Lastest date for which

Resource latest available the resource is
to available
ResourceModifiedDate string(date-time) Last modification date
Resource last modified of the resource
date
ResourceName string Name of the resource
Resource name
ResourceStatsuName string Status name of the
Resource status name resource
ResourceType integer(int32) Type of resource
Resource type
TypeDescription string Description for the type
Resource type of resource
description
TypeName string Type name of the
Resource type name resource

1998 | P a g e
 Project Online

TriggerResourcesWrapper
Summary:
Description: Project online on new resource response model

Properties:
Name Type Summary
value array of (TriggerResource) The list of trigger
Returned resources resources returned

1999 | P a g e
 Project Online

TriggerTask
Summary:
Description: Task Online Task Model

Properties:
Name Type Summary
ProjectId string Id of the project which
Project id the task is created in
TaskId string Id of the new task
Task id
ProjectName string Name of the project
Project name which the task is created
in
TaskName string Name of the new task
Task name
TaskCreatedDate string(date-time) Created date of the new
Task created date task
TaskModifieddate string(date-time) Last modified date of the
Task last modified date new task
TaskStartDate string(date-time) Starting date of the new
Task start date task
TaskFinishDate string(date-time) Finishing date of the new
Task finish date task
TaskPriority integer(int32) Priority of the new task
Task summary
TaskIsActive boolean Whether the task is still
Task is active active

2000 | P a g e
 Project Online

TriggerTasksWrapper
Summary:
Description: Project online on new task response model

Properties:
Name Type Summary
value array of (TriggerTask) The list of trigger tasks
Returned tasks returned

2001 | P a g e
 Redmine

Redmine
Redmine is a web based tool for software project management.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
ListIssues () List issues
CreateIssue Create an issue
(CreateIssueRequest issue)
GetIssue (string issue_id) Get issue by ID
UpdateIssue (string issue_id, Update an issue
UpdateIssueRequest issue)
ListProjects () List projects
CreateProject Create a project
(CreateProjectRequest
project)
GetProject (string project_id) Get project by ID
ListUsers () List users
GetUser (string user_id) Get user by ID
ListPriorities () List priorities

Triggers:
Name Summary
OnNewProject () When a project is created
OnNewIssue (string When an issue is created
project_id)

2002 | P a g e
 Redmine

OnUpdatedIssue (string When an issue is updated

project_id)

Objects:
Name Summary
CreateIssueRequest
CreateIssueResponse
CreateProjectRequest
CreateProjectResponse
GetIssueResponse
GetProjectResponse
GetUserResponse
IssueResponse
ListIssuesResponse
ListPrioritiesResponse
ListProjectsResponse
ListUsersResponse
ProjectResponse
UpdateIssueRequest
UserResponse

Actions:
ListIssues
Summary: List issues
Description: List issues.

Syntax:
Redmine.ListIssues ()

2003 | P a g e
 Redmine

Returns:
Type:ListIssuesResponse

CreateIssue
Summary: Create an issue
Description: Create an issue.

Syntax:
Redmine.CreateIssue (CreateIssueRequest issue)

Parameters:
Name Type Summary Required Related
Action
issue CreateIssueRequest True

Returns:
Type:CreateIssueResponse

GetIssue
Summary: Get issue by ID
Description: Get issue by ID.

Syntax:
Redmine.GetIssue (string issue_id)

Parameters:

2004 | P a g e
 Redmine

Name Type Summary Required Related

Action
issue_id string Issue. True
(Issue)

Returns:
Type:GetIssueResponse

UpdateIssue
Summary: Update an issue
Description: Update an issue.

Syntax:
Redmine.UpdateIssue (string issue_id, UpdateIssueRequest issue)

Parameters:
Name Type Summary Required Related
Action
issue_id string Issue. True ListIssues
(Issue)
issue UpdateIssueRequest True

Returns:
Type:string

ListProjects
Summary: List projects
Description: List projects.

2005 | P a g e
 Redmine

Syntax:
Redmine.ListProjects ()

Returns:
Type:ListProjectsResponse

CreateProject
Summary: Create a project
Description: Create a project.

Syntax:
Redmine.CreateProject (CreateProjectRequest project)

Parameters:
Name Type Summary Required Related
Action
project CreateProjectRequest True

Returns:
Type:CreateProjectResponse

GetProject
Summary: Get project by ID
Description: Get project by ID.

Syntax:
Redmine.GetProject (string project_id)

2006 | P a g e
 Redmine

Parameters:
Name Type Summary Required Related
Action
project_id string Project. True
(Project)

Returns:
Type:GetProjectResponse

ListUsers
Summary: List users
Description: List users.

Syntax:
Redmine.ListUsers ()

Returns:
Type:ListUsersResponse

GetUser
Summary: Get user by ID
Description: Get user by ID.

Syntax:
Redmine.GetUser (string user_id)

Parameters:

2007 | P a g e
 Redmine

Name Type Summary Required Related

Action
user_id string User. True
(User)

Returns:
Type:GetUserResponse

ListPriorities
Summary: List priorities
Description: List priorities.

Syntax:
Redmine.ListPriorities ()

Returns:
Type:ListPrioritiesResponse

Triggers:
Trigger OnNewProject
Summary: When a project is created
Description: When a project is created.

Syntax:
Redmine.OnNewProject ()

Returns:
Type:ListProjectsResponse

2008 | P a g e
 Redmine

Trigger OnNewIssue
Summary: When an issue is created
Description: When an issue is created.

Syntax:
Redmine.OnNewIssue (string project_id)

Parameters:
Name Type Summary Required Related
Action
project_id string Project. True ListProjects
(Project)

Returns:
Type:ListIssuesResponse

Trigger OnUpdatedIssue
Summary: When an issue is updated
Description: When an issue is updated.

Syntax:
Redmine.OnUpdatedIssue (string project_id)

Parameters:
Name Type Summary Required Related
Action
project_id string Project. True ListProjects
(Project)

2009 | P a g e
 Redmine

Returns:
Type:ListIssuesResponse

2010 | P a g e
 Redmine

CreateIssueRequest
Summary:
Description:

Properties:
Name Type Summary
issue Issue

Issue
Summary:
Description:

Properties:
Name Type Summary
project_id string Project.
Project
priority_id string Priority.
Priority
tracker_id string Tracker. Values: [Bug,
Tracker Feature, Support]
subject string Subject.
Subject
description string Description.
Description

2011 | P a g e
 Redmine

CreateIssueResponse
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Issue Id.
Issue Id
project Project

tracker Tracker

status Status

priority Priority

author Author

subject string Subject.

Subject
description string Description.
Description
start_date string Start date.
Start date
due_date string Due date.
Due date
done_ratio integer(int32) Done ratio.
Done ratio
estimated_hours number(float) Estimated hours.

2012 | P a g e
 Redmine

Estimated hours
total_estimated_hours number(float) Total estimated hours.
Total estimated hours
created_on string(date-time) Created on.
Created on
updated_on string(date-time) Updated on.
Updated on

Project
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Project Id.
Project Id
name string Project name.
Project name

Tracker
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Tracker Id.
Tracker Id
name string Tracker.
Tracker

2013 | P a g e
 Redmine

Status
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Status Id.
Status Id
name string Status.
Status

Priority
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Priority Id.
Priority Id
name string Priority.
Priority

Author
Summary:
Description:

Properties:

2014 | P a g e
 Redmine

Name Type Summary

id integer(int32) Author Id.
Author Id
name string Author.
Author

2015 | P a g e
 Redmine

CreateProjectRequest
Summary:
Description:

Properties:
Name Type Summary
project Project

Project
Summary:
Description:

Properties:
Name Type Summary
name string Name of project.
Name
identifier string Unique friendly name that
Identifier is different from id.
description string Description.
Description
homepage string Homepage.
Homepage
parent_id string Select the parent project.
Parent project
is_public boolean Is a public project.
Public
inherit_members boolean Inherit members.
Inherit members

2016 | P a g e
 Redmine

2017 | P a g e
 Redmine

CreateProjectResponse
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Project id.
Project id
name string Project name.
Project name
identifier string Unique friendly name that
Identifier is different from id.
description string Description.
Description
homepage string Homepage.
Homepage
parent Parent

status integer(int32) Status.

Status
is_public boolean Public.
Public
created_on string(date-time) Created on.
Created on
updated_on string(date-time) Updated on.
Updated on

Parent
Summary:

2018 | P a g e
 Redmine

Description:

Properties:
Name Type Summary
id integer(int32) Parent Id.
Parent Id
name string Parent.
Parent

2019 | P a g e
 Redmine

GetIssueResponse
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Issue Id.
Issue Id
project Project

tracker Tracker

status Status

priority Priority

author Author

subject string Subject.

Subject
description string Description.
Description
start_date string Start date.
Start date
due_date string Due date.
Due date
done_ratio integer(int32) Done ratio.
Done ratio
estimated_hours number(float) Estimated hours.

2020 | P a g e
 Redmine

Estimated hours
total_estimated_hours number(float) Total estimated hours.
Total estimated hours
spent_hours number(float) Spent hours.
Spent hours
total_spent_hours number(float) Total spent hours.
Total spent hours
created_on string(date-time) Created on.
Created on
updated_on string(date-time) Updated on.
Updated on

Project
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Project Id.
Project Id
name string Project name.
Project name

Tracker
Summary:
Description:

Properties:
Name Type Summary

2021 | P a g e
 Redmine

id integer(int32) Tracker Id.

Tracker Id
name string Tracker.
Tracker

Status
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Status Id.
Status Id
name string Status.
Status

Priority
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Priority Id.
Priority Id
name string Priority.
Priority

Author
Summary:

2022 | P a g e
 Redmine

Description:

Properties:
Name Type Summary
id integer(int32) Author Id.
Author Id
name string Author.
Author

2023 | P a g e
 Redmine

GetProjectResponse
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Project id.
Project id
name string Project name.
Project name
identifier string Unique friendly name that
Identifier is different from id.
description string Description.
Description
homepage string Homepage.
Homepage
status integer(int32) Status.
Status
is_public boolean Public.
Public
created_on string(date-time) Created on.
Created on
updated_on string(date-time) Updated on.
Updated on

2024 | P a g e
 Redmine

GetUserResponse
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) User Id.
User Id
login string Login.
Login
firstname string First name.
First name
lastname string Last name.
Last name
mail string Email.
Email
created_on string(date-time) Created on.
Created on
last_login_on string(date-time) Last login.
Last login
api_key string API key.
API key
status integer(int32) Status.
Status

2025 | P a g e
 Redmine

IssueResponse
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Issue Id.
Issue Id
project Project

tracker Tracker

status Status

priority Priority

author Author

subject string Subject.

Subject
description string Description.
Description
start_date string Start date.
Start date
due_date string Due date.
Due date
done_ratio integer(int32) Done ratio.
Done ratio
estimated_hours number(float) Estimated hours.

2026 | P a g e
 Redmine

Estimated hours
created_on string(date-time) Created on.
Created on
updated_on string(date-time) Updated on.
Updated on

Project
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Project Id.
Project Id
name string Project name.
Project name

Tracker
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Tracker Id.
Tracker Id
name string Tracker.
Tracker

2027 | P a g e
 Redmine

Status
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Status Id.
Status Id
name string Status.
Status

Priority
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Priority Id.
Priority Id
name string Priority.
Priority

Author
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Author Id.

2028 | P a g e
 Redmine

Author Id
name string Author.
Author

2029 | P a g e
 Redmine

ListIssuesResponse
Summary:
Description:

Properties:
Name Type Summary
issues array of (IssueResponse) Issues.
Issues

2030 | P a g e
 Redmine

ListPrioritiesResponse
Summary:
Description:

Properties:
Name Type Summary
issue_priorities array of (ProjectResponse) Priorities.
Projects

2031 | P a g e
 Redmine

ListProjectsResponse
Summary:
Description:

Properties:
Name Type Summary
projects array of (ProjectResponse) Projects.
Projects

2032 | P a g e
 Redmine

ListUsersResponse
Summary:
Description:

Properties:
Name Type Summary
users array of (UserResponse) Users.
Users

2033 | P a g e
 Redmine

ProjectResponse
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) Project id.
Project id
name string Project name.
Project name
identifier string Unique friendly name that
Identifier is different from id.
description string Description.
Description
status integer(int32) Status.
Status
is_public boolean Public.
Public
created_on string(date-time) Created on.
Created on
updated_on string(date-time) Updated on.
Updated on

2034 | P a g e
 Redmine

UpdateIssueRequest
Summary:
Description:

Properties:
Name Type Summary
issue Issue

Issue
Summary:
Description:

Properties:
Name Type Summary
priority_id string Priority.
Priority
tracker_id string Tracker. Values: [Bug,
Tracker Feature, Support]
status_id string Status. Values: [New, In
Status Progress, Resolved,
Feedback, Closed,
Rejected]
subject string Subject.
Subject
description string Description.
Description

2035 | P a g e
 Redmine

UserResponse
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) User Id.
User Id
login string Login.
Login
firstname string First name.
First name
lastname string Last name.
Last name
mail string Email.
Email
created_on string(date-time) Created on.
Created on
last_login_on string(date-time) Last login.
Last login

2036 | P a g e
 RSS

RSS
RSS is a popular web syndication format used to publish frequently updated
content – like blog entries and news headlines. Many content publishers
provide an RSS feed to allow users to subscribe to it. Use the RSS connector to
retrieve feed information and trigger flows when new items are published in an RSS
feed.

Status: Production Tier: Standard Version: 1.0

Actions:
Name Summary
ListFeedItems (string feedUrl) List all RSS feed items

Triggers:
Name Summary
OnNewFeed (string feedUrl) When a feed item is published

Objects:
Name Summary
FeedItem
TriggerBatchResponse[FeedItem]

Actions:
ListFeedItems
Summary: List all RSS feed items
Description: Get all RSS feed items

Syntax:

2037 | P a g e
 RSS

RSS.ListFeedItems (string feedUrl)

Parameters:
Nam Type Summary Requi Relat
e red ed
Actio
n
feed string The RSS feed URL (Example: True
Url (The RSS feed URL (Example: http://rss.cnn.com/rss/cnn_t
http://rss.cnn.com/rss/cnn_t opstories.rss)
opstories.rss))

Returns:
Type:array of (FeedItem)

Triggers:
Trigger OnNewFeed
Summary: When a feed item is published
Description: Triggers a workflow when a new feed item is published

Syntax:
RSS.OnNewFeed (string feedUrl)

Parameters:
Nam Type Summary Requi Relat
e red ed
Actio
n

2038 | P a g e
 RSS

feed string The RSS feed URL (Example: True

Url (The RSS feed URL (Example: http://rss.cnn.com/rss/cnn_t
http://rss.cnn.com/rss/cnn_t opstories.rss)
opstories.rss))

Returns:
Type:TriggerBatchResponse[FeedItem]

2039 | P a g e
 RSS

FeedItem
Summary:
Description: Feed item

Properties:
Name Type Summary
id string Feed ID
Feed ID
title string Feed title
Feed title
primaryLink string Primary feed link
Primary feed link
links array of (string) Feed links
Feed links
updatedOn string Feed updated on
Feed updated on
publishDate string Feed published date
Feed published on
summary string Feed item summary
Feed summary
copyright string Copyright information
Feed copyright
information
categories array of (string) Feed item categories
Feed categories

2040 | P a g e
 RSS

TriggerBatchResponse[FeedItem]
Summary:
Description:

Properties:
Name Type Summary
value array of (FeedItem)

2041 | P a g e
 SendGrid

SendGrid
SendGrid Connection Provider lets you send email and manage recipient lists.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
SendEmail (EmailRequest Send email
request)
SendEmailApiV3 Send email
(EmailRequestV3 request)
AddRecipientToList (string Add recipient to list
listId, string recipientId)
ListRecipientLists () List Recipient Lists
ListRecipients () List Recipients
GetScopes () Get list of accessible scopes

Triggers:
Name Summary

Objects:
Name Summary
EmailRequest
EmailRequestV3
EmailResponse
Object
Recipient

2042 | P a g e
 SendGrid

RecipientList
RecipientLists
Recipients
ScopeList

Actions:
SendEmail
Summary: Send email
Description: Sends an email using SendGrid API. (Limited to 10,000 recipients)

Syntax:
SendGrid.SendEmail (EmailRequest request)

Parameters:
Name Type Summary Required Related
Action
request EmailRequest Email Request True

Returns:
Type:EmailResponse
Description: Send Email Response

SendEmailApiV3
Summary: Send email
Description: Sends an email

Syntax:

2043 | P a g e
 SendGrid

SendGrid.SendEmailApiV3 (EmailRequestV3 request)

Parameters:
Name Type Summary Required Related
Action
request EmailRequestV3 Email Request True

Returns:
Type:EmailResponse
Description: Send Email Response

AddRecipientToList
Summary: Add recipient to list
Description: Add an individual recipient to a recipient list

Syntax:
SendGrid.AddRecipientToList (string listId, string recipientId)

Parameters:
Name Type Summary Required Related Action
listId string Unique id of True ListRecipientLists
(List id) the recipient
list
recipientId string Unique id of True ListRecipients
(Recipient the recipient
id)

Returns:

2044 | P a g e
 SendGrid

Type:Object

ListRecipientLists
Summary: List Recipient Lists
Description: Retrieves all the recipient lists

Syntax:
SendGrid.ListRecipientLists ()

Returns:
Type:RecipientLists
Description: List Recipients Response Item

ListRecipients
Summary: List Recipients
Description: Retrieves all registered recipients

Syntax:
SendGrid.ListRecipients ()

Returns:
Type:Recipients
Description: List of recipients

GetScopes
Summary: Get list of accessible scopes
Description: Retrieve a list of scopes for which that user has access

Syntax:

2045 | P a g e
 SendGrid

SendGrid.GetScopes ()

Returns:
Type:ScopeList
Description: List of scopes

2046 | P a g e
 SendGrid

EmailRequest
Summary:
Description: Email Request

Properties:
Name Type Summary
from string Origination address of
From your email. Must be a
valid email address from
your domain
fromname string Origination name of your
From name email
to string(email) Receiving address of your
To email. Must include one or
more valid comma
seperated email addresses
toname string Comma seperated
To names receiving names of your
email. Must match the
number of "to" email
addresses if specified
subject string Subject of your email
Subject
body string Content of your email.
Email body Supported formats include
plain text and HTML
ishtml boolean Specify whether the
Is Html content of the email is

2047 | P a g e
 SendGrid

HTML or plain text

Values: [true, false]
cc string(email) CC'ed addresses of your
CC email. Must include one or
more valid comma
seperated email addresses
ccname string Comma seperated names
CC names of the cc'ed recipients.
bcc string(email) Bcc addresses of your
Bcc email. Must include one or
more valid comma
seperated email addresses
bccname string Comma seperated names
Bcc names of the Bcc'ed recipients.
replyto string(email) Reply To address of your
Reply to email. Must be a valid
email address
date string(date-time) Specify the date header of
Date header your email (Example:
“Thu, 21 Dec 2000
16:01:07 +0200”). Must be
a valid date
headers string Custom email headers in
Custom headers json format
files array of (string) Attachment file content
Attachment
filenames array of (string) Attachment file names
Attachment file names

2048 | P a g e
 SendGrid

EmailRequestV3
Summary:
Description: Email Request

Properties:
Name Type Summary
from string(email) Origination address of
From your email. Must be a
valid email address from
your domain
fromname string Origination name of your
From name email
to string(email) Valid email addresses,
To separated by a comma
toname string A display name for each
To names email address, separated
by a comma
subject string Subject of your email
Subject
text string Content of your email
Email body
ishtml boolean Specify whether the
Is Html content of the email is
HTML or plain text
Values: [true, false]
cc string(email) Valid email addresses,
CC separated by a comma

2049 | P a g e
 SendGrid

ccname string A display name for each

CC names CC email address,
separated by a comma
bcc string(email) Valid email addresses,
Bcc separated by a comma
bccname string A display name for each
BCC names BCC email address,
separated by a comma
file string(byte) Attachment file content
Attachment
filename string Attachment file name
Attachment file name

2050 | P a g e
 SendGrid

EmailResponse
Summary:
Description: Send Email Response

Properties:
Name Type Summary
message string Status message from send
Status of the email sent: email response
success/failure

2051 | P a g e
 SendGrid

Object
Summary:
Description:

Properties:
Name Type Summary

2052 | P a g e
 SendGrid

Recipient
Summary:
Description: SendGrid recipient

Properties:
Name Type Summary
email string(email) Email address
email
last_name string Last name
Last
first_name string First name
First
id string Unique recipient id
Id

2053 | P a g e
 SendGrid

RecipientList
Summary:
Description: Recipient list

Properties:
Name Type Summary
id integer(int32) Unique list id
id
name string Name
name
recipient_count integer(int32) Recipient count
Recipient count

2054 | P a g e
 SendGrid

RecipientLists
Summary:
Description: List Recipients Response Item

Properties:
Name Type Summary
lists array of (RecipientList) List of recipient lists
Recipient lists

2055 | P a g e
 SendGrid

Recipients
Summary:
Description: List of recipients

Properties:
Name Type Summary
recipients array of (Recipient) List of recipients
Recipient List

2056 | P a g e
 SendGrid

ScopeList
Summary:
Description: List of scopes

Properties:
Name Type Summary
scopes array of (string) List of scopes
Scope List

2057 | P a g e
 Service Bus

Service Bus
Connect to Azure Service Bus to send and receive messages. You can perform
actions such as send to queue, send to topic, receive from queue, receive from
subscription, etc.

Status: Production Tier: Standard Version: 1.0

Actions:
Name Summary
GetQueues () Get all queues
GetTopics () Get all topics
GetSubscriptions (string topicName) Get the subscriptions for a topic
GetEntities () Get all entities
GetSystemProperties () Get the list of system properties
GetSessionOptions () Get session options
SendMessage (string entityName, Send message
ServiceBusMessage message,
[advanced][Optional]string
systemProperties)
CompleteMessageInQueue (string Complete the message in a queue
queueName, string lockToken,
[advanced][Optional]string queueType,
[advanced][Optional]string sessionId)
AbandonMessageInQueue (string Abandon the message in a queue
queueName, string lockToken,
[advanced][Optional]string queueType,
[advanced][Optional]string sessionId)

2058 | P a g e
 Service Bus

GetDeferredMessageFromQueue Get deferred message from a queue

(string queueName, integer
sequenceNumber,
[advanced][Optional]string queueType,
[advanced][Optional]string sessionId)
DeferMessageInQueue (string Defer the message in a queue
queueName, string lockToken,
[advanced][Optional]string queueType,
[advanced][Optional]string sessionId)
DeadLetterMessageInQueue (string Dead-letter the message in a queue
queueName, string lockToken,
[advanced][Optional]string sessionId)
GetMessagesFromQueueWithPeekLock Get messages from a queue (peek-lock)
(string queueName, [Optional]integer
maxMessageCount,
[advanced][Optional]string queueType,
[advanced][Optional]string sessionId)
CloseSessionInQueue (string Close a session in the queue
queueName, string sessionId)
CompleteMessageInTopic (string Complete the message in a topic
topicName, string subscriptionName, subscription
string lockToken,
[advanced][Optional]string
subscriptionType,
[advanced][Optional]string sessionId)
AbandonMessageInTopic (string Abandon the message in a topic
topicName, string subscriptionName, subscription
string lockToken,
[advanced][Optional]string

2059 | P a g e
 Service Bus

subscriptionType,
[advanced][Optional]string sessionId)
GetDeferredMessageFromTopic (string Get deferred message from a topic
topicName, string subscriptionName, subscription
integer sequenceNumber,
[advanced][Optional]string
subscriptionType,
[advanced][Optional]string sessionId)
DeferMessageInTopic (string Defer the message in a topic subscription
topicName, string subscriptionName,
string lockToken,
[advanced][Optional]string
subscriptionType,
[advanced][Optional]string sessionId)
DeadLetterMessageInTopic (string Dead-letter the message in a topic
topicName, string subscriptionName, subscription
string lockToken,
[advanced][Optional]string sessionId)
CreateTopicSubscription (string Create a topic subscription
topicName, string subscriptionName,
SubscriptionFilter subscriptionFilter,
[advanced][Optional]string
subscriptionFilterType)
DeleteTopicSubscription (string Delete a topic subscription
topicName, string subscriptionName)
GetMessagesFromTopicWithPeekLock Get messages from a topic subscription
(string topicName, string (peek-lock)
subscriptionName, [Optional]integer
maxMessageCount,

2060 | P a g e
 Service Bus

[advanced][Optional]string
subscriptionType,
[advanced][Optional]string sessionId)
CloseSessionInTopic (string topicName, Close a session in the topic
string subscriptionName, string
sessionId)
GetSubscriptionFilter (string Get metadata of a filter
subscriptionFilterType)

Triggers:
Name Summary
GetMessageFromQueue (string When a message is received in a
queueName, [advanced][Optional]string queue (auto-complete)
queueType)
GetNewMessageFromQueueWithPeekLock When a message is received in a
(string queueName, queue (peek-lock)
[advanced][Optional]string queueType,
[advanced][Optional]string sessionId)
GetMessagesFromQueue (string When one or more messages arrive in
queueName, [Optional]integer a queue (auto-complete)
maxMessageCount,
[advanced][Optional]string queueType)
GetNewMessagesFromQueueWithPeekLock When one or more messages arrive in
(string queueName, [Optional]integer a queue (peek-lock)
maxMessageCount,
[advanced][Optional]string queueType,
[advanced][Optional]string sessionId)

2061 | P a g e
 Service Bus

GetMessageFromTopic (string topicName, When a message is received in a topic

string subscriptionName, subscription (auto-complete)
[advanced][Optional]string
subscriptionType)
GetNewMessageFromTopicWithPeekLock When a message is received in a topic
(string topicName, string subscription (peek-lock)
subscriptionName,
[advanced][Optional]string
subscriptionType,
[advanced][Optional]string sessionId)
GetMessagesFromTopic (string topicName, When one or more messages arrive in
string subscriptionName, [Optional]integer a topic (auto-complete)
maxMessageCount,
[advanced][Optional]string
subscriptionType)
GetNewMessagesFromTopicWithPeekLock When one or more messages arrive in
(string topicName, string a topic (peek-lock)
subscriptionName, [Optional]integer
maxMessageCount,
[advanced][Optional]string
subscriptionType,
[advanced][Optional]string sessionId)

Objects:
Name Summary
ServiceBusEntity
ServiceBusMessage
Subscription

2062 | P a g e
 Service Bus

SubscriptionCorrelationFilter
SubscriptionFilter

Actions:
GetQueues
Summary: Get all queues
Description: This operation gets all queues in the Service Bus namespace.

Syntax:
ServiceBus.GetQueues ()

Returns:
Type:array of (string)

GetTopics
Summary: Get all topics
Description: This operation gets all topics in the Service Bus namespace.

Syntax:
ServiceBus.GetTopics ()

Returns:
Type:array of (string)

GetSubscriptions
Summary: Get the subscriptions for a topic
Description: This operation gets the list of subscriptions for a topic in the Service Bus
namespace.

2063 | P a g e
 Service Bus

Syntax:
ServiceBus.GetSubscriptions (string topicName)

Parameters:
Name Type Summary Required Related
Action
topicName string Topic name True
(Topic
name)

Returns:
Type:array of (string)

GetEntities
Summary: Get all entities
Description: This operation gets all queues and topics in the Service Bus namespace.

Syntax:
ServiceBus.GetEntities ()

Returns:
Type:array of (ServiceBusEntity)

GetSystemProperties
Summary: Get the list of system properties
Description: This operation gets list of properties.

Syntax:

2064 | P a g e
 Service Bus

ServiceBus.GetSystemProperties ()

Returns:
Type:array of (string)

GetSessionOptions
Summary: Get session options
Description: This operation gets the list of options for session handling - None, Next
available.

Syntax:
ServiceBus.GetSessionOptions ()

Returns:
Type:array of (string)

SendMessage
Summary: Send message
Description: This operation sends a message to a queue or topic.

Syntax:
ServiceBus.SendMessage (string entityName, ServiceBusMessage
message, [advanced][Optional]string systemProperties)

Parameters:
Name Type Summary Require Related Action
d
entityName string Name of True GetEntities
the

2065 | P a g e
 Service Bus

(Queue/Topic queue or
name) topic
message ServiceBusMessag Service True
e Bus
Message
systemPropertie string System False GetSystemPropertie
s (System propertie s
properties) s - None
or Run
Details.
Run
Details
will add
run
metadata
property
details as
custom
propertie
s in the
message.

Returns:

CompleteMessageInQueue
Summary: Complete the message in a queue
Description: The operation completes a message in a queue.

Syntax:

2066 | P a g e
 Service Bus

ServiceBus.CompleteMessageInQueue (string queueName, string

lockToken, [advanced][Optional]string queueType,
[advanced][Optional]string sessionId)

Parameters:
Name Type Summary Required Related
Action
queueName string Name of the True GetQueues
(Queue queue
name)
lockToken string Lock token of True
(Lock token the message to
of the complete
message)
queueType string Queue type - False
(Queue Main or
type)Values: DeadLetter
[Main,
DeadLetter]
sessionId string Session id False
(Session id)

Returns:

AbandonMessageInQueue
Summary: Abandon the message in a queue
Description: The operation abandons a message in a queue.

Syntax:

2067 | P a g e
 Service Bus

ServiceBus.AbandonMessageInQueue (string queueName, string

lockToken, [advanced][Optional]string queueType,
[advanced][Optional]string sessionId)

Parameters:
Name Type Summary Required Related
Action
queueName string Name of the True GetQueues
(Queue queue
name)
lockToken string Lock token of True
(Lock token the message to
of the abandon
message)
queueType string Queue type - False
(Queue Main or
type)Values: DeadLetter
[Main,
DeadLetter]
sessionId string Session id False
(Session id)

Returns:

GetDeferredMessageFromQueue
Summary: Get deferred message from a queue
Description: The operation gets a deferred message from a queue.

Syntax:

2068 | P a g e
 Service Bus

ServiceBus.GetDeferredMessageFromQueue (string queueName,

integer sequenceNumber, [advanced][Optional]string queueType,
[advanced][Optional]string sessionId)

Parameters:
Name Type Summary Required Related
Action
queueName string Name of the True GetQueues
(Queue queue
name)
sequenceNumber integer(int64) Sequence True
(Sequence number of
number of message
message)
queueType string Queue type - False
(Queue Main or
type)Values: DeadLetter
[Main,
DeadLetter]
sessionId string Session id False
(Session id)

Returns:
Type:ServiceBusMessage
Description: Service Bus Message

DeferMessageInQueue
Summary: Defer the message in a queue
Description: The operation defers a message in a queue.

2069 | P a g e
 Service Bus

Syntax:
ServiceBus.DeferMessageInQueue (string queueName, string
lockToken, [advanced][Optional]string queueType,
[advanced][Optional]string sessionId)

Parameters:
Name Type Summary Required Related
Action
queueName string Name of the True GetQueues
(Queue queue
name)
lockToken string Lock token of True
(Lock token the message to
of the defer
message)
queueType string Queue type - False
(Queue Main or
type)Values: DeadLetter
[Main,
DeadLetter]
sessionId string Session id False
(Session id)

Returns:

DeadLetterMessageInQueue
Summary: Dead-letter the message in a queue
Description: The operation moves the message to the Dead-Letter Queue.

2070 | P a g e
 Service Bus

Syntax:
ServiceBus.DeadLetterMessageInQueue (string queueName, string
lockToken, [advanced][Optional]string sessionId)

Parameters:
Name Type Summary Required Related
Action
queueName string Name of the True GetQueues
(Queue queue
name)
lockToken string Lock token of True
(Lock token the message to
of the dead-letter
message)
sessionId string Session id False
(Session id)

Returns:

GetMessagesFromQueueWithPeekLock
Summary: Get messages from a queue (peek-lock)
Description: The operation receives messages from a queue with peek-lock. If
maximum message count is not provided, it reads 20 messages.

Syntax:
ServiceBus.GetMessagesFromQueueWithPeekLock (string queueName,
[Optional]integer maxMessageCount, [advanced][Optional]string
queueType, [advanced][Optional]string sessionId)

2071 | P a g e
 Service Bus

Parameters:
Name Type Summary Required Related
Action
queueName string Name of the True GetQueues
(Queue queue
name)
maxMessageCount integer(int32) The maximum False
(Maximum number of
message messages to
count) return in the
batch
queueType string Queue type - False
(Queue Main or
type)Values: DeadLetter
[Main,
DeadLetter]
sessionId string Session id False
(Session id)

Returns:
Type:array of (ServiceBusMessage)

CloseSessionInQueue
Summary: Close a session in the queue
Description: The operation closes a session in the queue.

Syntax:

2072 | P a g e
 Service Bus

ServiceBus.CloseSessionInQueue (string queueName, string

sessionId)

Parameters:
Name Type Summary Required Related
Action
queueName string Name of the True GetQueues
(Queue queue
name)
sessionId string Session id True
(Session id)

Returns:

CompleteMessageInTopic
Summary: Complete the message in a topic subscription
Description: The operation completes a message in a topic subscription.

Syntax:
ServiceBus.CompleteMessageInTopic (string topicName, string
subscriptionName, string lockToken, [advanced][Optional]string
subscriptionType, [advanced][Optional]string sessionId)

Parameters:
Name Type Summary Required Related Action
topicName string Name of the True GetTopics
(Topic name) topic

2073 | P a g e
 Service Bus

subscriptionName string Name of the True GetSubscriptions

(Topic topic
subscription subscription
name)
lockToken string Lock token of True
(Lock token the message
of the to complete
message)
subscriptionType string Subscription False
(Subscription type - Main or
type)Values: DeadLetter
[Main,
DeadLetter]
sessionId string Session id False
(Session id)

Returns:

AbandonMessageInTopic
Summary: Abandon the message in a topic subscription
Description: The operation abandons a message in a topic subscription.

Syntax:
ServiceBus.AbandonMessageInTopic (string topicName, string
subscriptionName, string lockToken, [advanced][Optional]string
subscriptionType, [advanced][Optional]string sessionId)

Parameters:
Name Type Summary Required Related Action

2074 | P a g e
 Service Bus

topicName string Name of the True GetTopics

(Topic name) topic
subscriptionName string Name of the True GetSubscriptions
(Topic topic
subscription subscription
name)
lockToken string Lock token of True
(Lock token the message
of the to abandon
message)
subscriptionType string Subscription False
(Subscription type - Main or
type)Values: DeadLetter
[Main,
DeadLetter]
sessionId string Session id False
(Session id)

Returns:

GetDeferredMessageFromTopic
Summary: Get deferred message from a topic subscription
Description: The operation gets a deferred message from a topic subscription.

Syntax:
ServiceBus.GetDeferredMessageFromTopic (string topicName, string
subscriptionName, integer sequenceNumber,
[advanced][Optional]string subscriptionType,
[advanced][Optional]string sessionId)

2075 | P a g e
 Service Bus

Parameters:
Name Type Summary Required Related Action
topicName string Name of the True GetTopics
(Topic name) topic
subscriptionName string Name of the True GetSubscriptions
(Topic topic
subscription subscription
name)
sequenceNumber integer(int64) Sequence True
(Sequence number of
number of message
message)
subscriptionType string Queue type - False
(Subscription Main or
type)Values: DeadLetter
[Main,
DeadLetter]
sessionId string Session id False
(Session id)

Returns:
Type:ServiceBusMessage
Description: Service Bus Message

DeferMessageInTopic
Summary: Defer the message in a topic subscription
Description: The operation defers a message in a topic subscription.

Syntax:

2076 | P a g e
 Service Bus

ServiceBus.DeferMessageInTopic (string topicName, string

subscriptionName, string lockToken, [advanced][Optional]string
subscriptionType, [advanced][Optional]string sessionId)

Parameters:
Name Type Summary Required Related Action
topicName string Name of the True GetTopics
(Topic name) topic
subscriptionName string Name of the True GetSubscriptions
(Topic topic
subscription subscription
name)
lockToken string Lock token of True
(Lock token the message
of the to defer
message)
subscriptionType string Subscription False
(Subscription type - Main or
type)Values: DeadLetter
[Main,
DeadLetter]
sessionId string Session id False
(Session id)

Returns:

DeadLetterMessageInTopic
Summary: Dead-letter the message in a topic subscription
Description: The operation moves the message to the topic Dead-Letter Queue.

2077 | P a g e
 Service Bus

Syntax:
ServiceBus.DeadLetterMessageInTopic (string topicName, string
subscriptionName, string lockToken, [advanced][Optional]string
sessionId)

Parameters:
Name Type Summary Required Related Action
topicName string Name of the True GetTopics
(Topic topic
name)
subscriptionName string Name of the True GetSubscriptions
(Topic topic
subscription subscription
name)
lockToken string Lock token of True
(Lock token the message
of the to dead-letter
message)
sessionId string Session id False
(Session id)

Returns:

CreateTopicSubscription
Summary: Create a topic subscription
Description: The operation creates a topic subscription.

Syntax:

2078 | P a g e
 Service Bus

ServiceBus.CreateTopicSubscription (string topicName, string

subscriptionName, SubscriptionFilter subscriptionFilter,
[advanced][Optional]string subscriptionFilterType)

Parameters:
Name Type Summary Required Related
Action
topicName string Name of the True GetTopics
(Topic name) topic
subscriptionName string Name of the True
(Topic topic
subscription subscription
name)
subscriptionFilter SubscriptionFilter The service True
bus filter for a
topic
subscription.
subscriptionFilterType string Filter type False
(Filter
type)Values:
[None,
Correlation]

Returns:
Type:Subscription
Description: The topic subscription.

DeleteTopicSubscription
Summary: Delete a topic subscription

2079 | P a g e
 Service Bus

Description: The operation deletes a topic subscription.

Syntax:
ServiceBus.DeleteTopicSubscription (string topicName, string
subscriptionName)

Parameters:
Name Type Summary Required Related
Action
topicName string Name of the True GetTopics
(Topic topic
name)
subscriptionName string Name of the True
(Topic topic
subscription subscription
name)

Returns:

GetMessagesFromTopicWithPeekLock
Summary: Get messages from a topic subscription (peek-lock)
Description: The operation receives messages from a topic subscription with peek-
lock. If maximum message count is not provided, it reads 20 messages.

Syntax:
ServiceBus.GetMessagesFromTopicWithPeekLock (string topicName,
string subscriptionName, [Optional]integer maxMessageCount,
[advanced][Optional]string subscriptionType,
[advanced][Optional]string sessionId)

2080 | P a g e
 Service Bus

Parameters:
Name Type Summary Required Related Action
topicName string Name of the True GetTopics
(Topic name) topic
subscriptionName string Name of the True GetSubscriptions
(Topic topic
subscription subscription
name)
maxMessageCount integer(int32) The False
(Maximum maximum
message number of
count) messages to
return in the
batch
subscriptionType string Subscription False
(Subscription type - Main
type)Values: or DeadLetter
[Main,
DeadLetter]
sessionId string Session id False
(Session id)

Returns:
Type:array of (ServiceBusMessage)

CloseSessionInTopic
Summary: Close a session in the topic
Description: The operation closes a session in the topic.

2081 | P a g e
 Service Bus

Syntax:
ServiceBus.CloseSessionInTopic (string topicName, string
subscriptionName, string sessionId)

Parameters:
Name Type Summary Required Related Action
topicName string Name of the True GetTopics
(Topic topic
name)
subscriptionName string Name of the True GetSubscriptions
(Topic topic
subscription subscription
name)
sessionId string Session id True
(Session id)

Returns:

GetSubscriptionFilter
Summary: Get metadata of a filter
Description: Get metadata of a filter

Syntax:
ServiceBus.GetSubscriptionFilter (string subscriptionFilterType)

Parameters:
Name Type Summary Required Related
Action

2082 | P a g e
 Service Bus

subscriptionFilterType string Subscription True

(Subscription filter type
filter
type)Values:
[None,
Correlation]

Returns:
Type:SubscriptionFilter
Description: The service bus filter for a topic subscription.

Triggers:
Trigger GetMessageFromQueue
Summary: When a message is received in a queue (auto-complete)
Description: This operation triggers a flow when a message is received in a queue and
auto completes the message.

Syntax:
ServiceBus.GetMessageFromQueue (string queueName,
[advanced][Optional]string queueType)

Parameters:
Name Type Summary Required Related
Action
queueName string Name of the True GetQueues
(Queue queue
name)

2083 | P a g e
 Service Bus

queueType string Queue type - False

(Queue Main or
type)Values: DeadLetter
[Main,
DeadLetter]

Returns:
Type:ServiceBusMessage
Description: Service Bus Message

Trigger GetNewMessageFromQueueWithPeekLock
Summary: When a message is received in a queue (peek-lock)
Description: The operation triggers a flow when a message received in a queue with
peek-lock mode.

Syntax:
ServiceBus.GetNewMessageFromQueueWithPeekLock (string queueName,
[advanced][Optional]string queueType, [advanced][Optional]string
sessionId)

Parameters:
Name Type Summary Required Related Action
queueName string Name of the True GetQueues
(Queue queue
name)
queueType string Queue type - False
(Queue Main or
type)Values: DeadLetter

2084 | P a g e
 Service Bus

[Main,
DeadLetter]
sessionId string Session id - False GetSessionOptions
(Session id) None or Next
Available or
provide
session id

Returns:
Type:ServiceBusMessage
Description: Service Bus Message

Trigger GetMessagesFromQueue
Summary: When one or more messages arrive in a queue (auto-complete)
Description: The operation receives one or more messages from a queue. If maximum
message count is not provided, it reads 20 messages.

Syntax:
ServiceBus.GetMessagesFromQueue (string queueName,
[Optional]integer maxMessageCount, [advanced][Optional]string
queueType)

Parameters:
Name Type Summary Required Related
Action
queueName string Name of the True GetQueues
(Queue queue
name)

2085 | P a g e
 Service Bus

maxMessageCount integer(int32) The maximum False

(Maximum number of
message messages to
count) return in the
batch
queueType string Queue type - False
(Queue Main or
type)Values: DeadLetter
[Main,
DeadLetter]

Returns:
Type:array of (ServiceBusMessage)

Trigger GetNewMessagesFromQueueWithPeekLock
Summary: When one or more messages arrive in a queue (peek-lock)
Description: The operation receives one or more messages from a queue with peek-
lock. If maximum message count is not provided, it reads 20 messages.

Syntax:
ServiceBus.GetNewMessagesFromQueueWithPeekLock (string
queueName, [Optional]integer maxMessageCount,
[advanced][Optional]string queueType, [advanced][Optional]string
sessionId)

Parameters:
Name Type Summary Required Related Action
queueName string Name of the True GetQueues
queue

2086 | P a g e
 Service Bus

(Queue
name)
maxMessageCount integer(int32) The False
(Maximum maximum
message number of
count) messages to
return in the
batch
queueType string Queue type False
(Queue - Main or
type)Values: DeadLetter
[Main,
DeadLetter]
sessionId string Session id - False GetSessionOptions
(Session id) None or
Next
Available or
provide
session id

Returns:
Type:array of (ServiceBusMessage)

Trigger GetMessageFromTopic
Summary: When a message is received in a topic subscription (auto-complete)
Description: This operation triggers a flow when a message is received in a topic
subscription and auto completes the message.

Syntax:

2087 | P a g e
 Service Bus

ServiceBus.GetMessageFromTopic (string topicName, string

subscriptionName, [advanced][Optional]string subscriptionType)

Parameters:
Name Type Summary Required Related Action
topicName string Name of the True GetTopics
(Topic name) topic
subscriptionName string Name of the True GetSubscriptions
(Topic topic
subscription subscription
name)
subscriptionType string Subscription False
(Subscription type - Main or
type)Values: DeadLetter
[Main,
DeadLetter]

Returns:
Type:ServiceBusMessage
Description: Service Bus Message

Trigger GetNewMessageFromTopicWithPeekLock
Summary: When a message is received in a topic subscription (peek-lock)
Description: The operation triggers a flow when a message received in a topic
subscription with peek-lock mode.

Syntax:

2088 | P a g e
 Service Bus

ServiceBus.GetNewMessageFromTopicWithPeekLock (string topicName,

string subscriptionName, [advanced][Optional]string
subscriptionType, [advanced][Optional]string sessionId)

Parameters:
Name Type Summary Required Related Action
topicName string Name of the True GetTopics
(Topic name) topic
subscriptionName string Name of the True GetSubscriptions
(Topic topic
subscription subscription
name)
subscriptionType string Subscription False
(Subscription type - Main
type)Values: or
[Main, DeadLetter
DeadLetter]
sessionId string Session id - False GetSessionOptions
(Session id) None or Next
Available or
provide
session id

Returns:
Type:ServiceBusMessage
Description: Service Bus Message

Trigger GetMessagesFromTopic
Summary: When one or more messages arrive in a topic (auto-complete)

2089 | P a g e
 Service Bus

Description: The operation receives one or more messages from a topic. If maximum
message count is not provided, it reads 20 messages.

Syntax:
ServiceBus.GetMessagesFromTopic (string topicName, string
subscriptionName, [Optional]integer maxMessageCount,
[advanced][Optional]string subscriptionType)

Parameters:
Name Type Summary Required Related Action
topicName string Name of the True GetTopics
(Topic name) topic
subscriptionName string Name of the True GetSubscriptions
(Topic topic
subscription subscription
name)
maxMessageCount integer(int32) The False
(Maximum maximum
message number of
count) messages to
return in the
batch
subscriptionType string Subscription False
(Subscription type - Main
type)Values: or DeadLetter
[Main,
DeadLetter]

Returns:

2090 | P a g e
 Service Bus

Type:array of (ServiceBusMessage)

Trigger GetNewMessagesFromTopicWithPeekLock
Summary: When one or more messages arrive in a topic (peek-lock)
Description: The operation receives one or more messages from a topic with peek-
lock. If maximum message count is not provided, it reads 20 messages.

Syntax:
ServiceBus.GetNewMessagesFromTopicWithPeekLock (string
topicName, string subscriptionName, [Optional]integer
maxMessageCount, [advanced][Optional]string subscriptionType,
[advanced][Optional]string sessionId)

Parameters:
Name Type Summary Required Related Action
topicName string Name of the True GetTopics
(Topic name) topic
subscriptionName string Name of the True GetSubscriptions
(Topic topic
subscription subscription
name)
maxMessageCount integer(int32) The False
(Maximum maximum
message number of
count) messages to
return in the
batch
subscriptionType string Subscription False
type - Main

2091 | P a g e
 Service Bus

(Subscription or
type)Values: DeadLetter
[Main,
DeadLetter]
sessionId string Session id - False GetSessionOptions
(Session id) None or
Next
Available or
provide
session id

Returns:
Type:array of (ServiceBusMessage)

2092 | P a g e
 Service Bus

ServiceBusEntity
Summary:
Description: Entity with name and display name.

Properties:
Name Type Summary
Name string The entity name

DisplayName string The display name for the

entity

2093 | P a g e
 Service Bus

ServiceBusMessage
Summary:
Description: Service Bus Message

Properties:
Name Type Summary
ContentData string(byte) Content of the
Content message
ContentType string Content type of the
Content Type message content
ContentTransferEncoding string Content transfer
Content Transfer Encoding encoding of the
message content
("none"|"base64")
Values: [None, Base64]
Properties Properties Key-value pairs for
Properties each brokered
property
MessageId string This is a user-defined
Message Id value that Service Bus
can use to identify
duplicate messages, if
enabled.
To string Send to address
To
ReplyTo string Address of the queue
Reply To to reply to
ReplyToSessionId string Identifier of the
Reply To Session Id session to reply to

2094 | P a g e
 Service Bus

Label string Application specific

Label label
ScheduledEnqueueTimeUtc string(date-time) Date and time, in UTC,
ScheduledEnqueueTimeUtc when the message will
be added to the queue
SessionId string Identifier of the
Session Id session
CorrelationId string Identifier of the
Correlation Id correlation
SequenceNumber integer(int64) Identifier of the
Sequence Number sequence number
LockToken string The lock token of the
Lock Token message as a string.
TimeToLive string(int64) This is the duration, in
Time To Live ticks, that a message is
valid. The duration
starts from when the
message is sent to the
Service Bus.

Properties
Summary: Properties
Description: Key-value pairs for each brokered property

Properties:
Name Type Summary

2095 | P a g e
 Service Bus

Subscription
Summary:
Description: The topic subscription.

Properties:
Name Type Summary
SubscriptionName string Subscription name.
Subscription name

2096 | P a g e
 Service Bus

SubscriptionCorrelationFilter
Summary:
Description: This object has the basic properties of a message for the correlation filter.

Properties:
Name Type Summary
CorrelationId string Identifier of the
correlation
Label string Application specific label

MessageId string This is a user-defined

value that Service Bus can
use to identify duplicate
messages, if enabled.
Properties Properties Key-value pairs for each
brokered property
ReplyTo string Address of the queue to
reply to
ReplyToSessionId string Identifier of the session to
reply to
SessionId string Identifier of the session

To string Send to address

ContentType string Content type of the

message content

Properties
Summary:

2097 | P a g e
 Service Bus

Description: Key-value pairs for each brokered property

Properties:
Name Type Summary

2098 | P a g e
 Service Bus

SubscriptionFilter
Summary:
Description: The service bus filter for a topic subscription.

Properties:
Name Type Summary
CorrelationFilter SubscriptionCorrelationFilter This object has the basic
properties of a message
for the correlation filter.

2099 | P a g e
 Slack

Slack
Slack is a team communication tool, that brings together all of your team
communications in one place, instantly searchable and available wherever you
go.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
PostMessage (string channel, Post Message
string text,
[advanced][Optional]string
username,
[advanced][Optional]boolean
as_user,
[advanced][Optional]string
parse,
[advanced][Optional]integer
link_names,
[advanced][Optional]boolean
unfurl_links,
[advanced][Optional]boolean
unfurl_media,
[advanced][Optional]string
icon_url,
[advanced][Optional]string
icon_emoji)

2100 | P a g e
 Slack

Triggers:
Name Summary

Objects:
Name Summary
MessageItem
PostOperationResponse

Actions:
PostMessage
Summary: Post Message
Description: Post a Message to a specified channel.

Syntax:
Slack.PostMessage (string channel, string text,
[advanced][Optional]string username, [advanced][Optional]boolean
as_user, [advanced][Optional]string parse,
[advanced][Optional]integer link_names,
[advanced][Optional]boolean unfurl_links,
[advanced][Optional]boolean unfurl_media,
[advanced][Optional]string icon_url, [advanced][Optional]string
icon_emoji)

Parameters:
Name Type Summary Require Relate
d d
Action
channel string Channel, private group, or IM True
(Channel channel to send message to. Can
Name)

2101 | P a g e
 Slack

be a name(ex: #general) or an
encoded ID.
text string Text of the message to send. For True
(Message formatting options, see
Text) https://api.slack.com/docs/formatt
ing.
username string Name of the bot False
(Bot Name)
as_user boolean Pass true to post the message as False
(Post As the authenticated user, instead of
User) as a bot
parse string Change how messages are treated. False
(Parse For details, see
Mode)Value https://api.slack.com/docs/formatt
s: [full, ing.
none]
link_names integer(int3 Find and link channel names and False
2) usernames.
(Link
Names)
unfurl_links boolean Pass true to enable unfurling of False
(Unfurl primarily text-based content.
Links)
unfurl_med boolean Pass false to disable unfurling of False
ia (Unfurl media content.
Media)
icon_url string(uri) URL to an image to use as an icon False
(Icon Url) for this message

2102 | P a g e
 Slack

icon_emoji string Emoji to use as an icon for this False

(Icon Emoji) message

Returns:
Type:PostOperationResponse
Description: Represents response of post operation of Slack Connector for
posting to Slack

2103 | P a g e
 Slack

MessageItem
Summary:
Description: A channel message.

Properties:
Name Type Summary
text string Message content text

id string Message Id

user string Id of the user who posted

the message
created integer(int64) Unix timestamp for when
the message is created
is_user-deleted boolean Whether or not the
message has been deleted

2104 | P a g e
 Slack

PostOperationResponse
Summary:
Description: Represents response of post operation of Slack Connector for posting to
Slack

Properties:
Name Type Summary
ok boolean Indicates if the operation
was successful
channel string The channel which the
message was posted to.
ts string The time stamp for when
the message is posted.
message MessageItem A channel message.

error string Error messages (if any).

2105 | P a g e
 Smartsheet

Smartsheet
Smartsheet is a powerful work management and collaboration tool that lets
you easily track and manage your work so you and your team can be more
productive than ever. Use it to collaborate with others, track progress on any
project, automate processes, and better structure your work.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
ListSheets ([Optional]string Get a list of sheets
optionalFolderId)
GetSheet (string sheetId, Get a sheet
[Optional]string columns)
GetColumns (string sheetId) Get the columns of a sheet
GetColumnsSchema (string Get the columns of a sheet in dynamic schema
sheetId) format
InsertRow (string sheetId, Insert row
RowPost row)
ListAllRootFolders () Gets the root folder for the file picker
ListSubFolders (string id) Get subfolders of a folder
ListFolder (string id) Gets a folders items for the file picker
GetDiscussionsForSheet Get discussions for a sheet
(string sheetId)
AddDiscussionToSheet (string Add a discussion to a sheet
sheetId, Discussion
discussion)

2106 | P a g e
 Smartsheet

AddDiscussionToRow (string Add a discussion to a row

sheetId, string rowId,
Discussion discussion)
AddCommentToDiscussion Add a comment to a discussion
(string sheetId, string
discussionId, Comment
comment)
GetDiscussion (string sheetId, Get a discussion
string discussionId)

Triggers:
Name Summary
OnNewSheet ([Optional]string When a new sheet is created
optionalFolderId)
OnUpdatedSheet When any sheet is updated
([Optional]string
optionalFolderId)
OnNewComment (string When a comment is added to a sheet
sheetId)
OnUpdatedSpecificSheet When a specific sheet is updated
(string sheetId,
[Optional]string columns)
OnRowCreated (string When a new row is created
sheetId, [Optional]string
columns)
OnCommentAdded (string When a comment is added to a discussion
sheetId, string discussionId)

2107 | P a g e
 Smartsheet

OnDiscussionCreated (string When a discussion is added to a sheet

sheetId)

Objects:
Name Summary
BlobMetaData
Column
Comment
CommentResponse
CreateCommentResponse
Discussion
DiscussionComment
DiscussionCommentUser
DiscussionData
DiscussionResponse
DiscussionUser
Folder
GetDiscussionResponse
InsertRowResponse
InsertRowResponseResult
RowCell
RowData
RowPost
RowResponse
Sheet
SheetWithRows
SmartsheetCollection[Column]
SmartsheetCollection[DiscussionComment]

2108 | P a g e
 Smartsheet

SmartsheetCollection[Folder]
SmartsheetCollection[GetDiscussionResponse]
SmartsheetCollection[SheetWithRows]
SmartsheetCollection[Sheet]

Actions:
ListSheets
Summary: Get a list of sheets
Description: Get a list of sheets

Syntax:
Smartsheet.ListSheets ([Optional]string optionalFolderId)

Parameters:
Name Type Summary Required Related
Action
optionalFolderId string Folder id for the False
(Optional folder containing
folder to the sheets
look in for
sheets
(defaults to
all))

Returns:
Type:SmartsheetCollection[Sheet]
Description: A common pattern for requesting collections from smartsheet

2109 | P a g e
 Smartsheet

GetSheet
Summary: Get a sheet
Description: Get a sheet

Syntax:
Smartsheet.GetSheet (string sheetId, [Optional]string columns)

Parameters:
Name Type Summary Required Related
Action
sheetId string The sheet to get True
(Sheet Id)
columns string The list of False
(Comma columns to
separated return
columns to
return)

Returns:
Type:SheetWithRows
Description: A Smartsheet with rows

GetColumns
Summary: Get the columns of a sheet
Description: Get the columns of a sheet

Syntax:
Smartsheet.GetColumns (string sheetId)

2110 | P a g e
 Smartsheet

Parameters:
Name Type Summary Required Related
Action
sheetId string The sheet to get True
(Sheet Id) the columns for

Returns:
Type:SmartsheetCollection[Column]
Description: A common pattern for requesting collections from smartsheet

GetColumnsSchema
Summary: Get the columns of a sheet in dynamic schema format
Description: Get the columns of a sheet in dynamic schema format

Syntax:
Smartsheet.GetColumnsSchema (string sheetId)

Parameters:
Name Type Summary Required Related
Action
sheetId string The sheet to get True
(Sheet Id) the columns for

Returns:
Type:string

InsertRow
Summary: Insert row
Description: Insert row

2111 | P a g e
 Smartsheet

Syntax:
Smartsheet.InsertRow (string sheetId, RowPost row)

Parameters:
Name Type Summary Required Related
Action
sheetId string The sheet to True
(Sheet Id) insert into
row RowPost An object that True
represents the
posting of a row

Returns:
Type:InsertRowResponse
Description: Response to InsertRow operation

ListAllRootFolders
Summary: Gets the root folder for the file picker
Description: Gets the root folder for the file picker

Syntax:
Smartsheet.ListAllRootFolders ()

Returns:
Type:array of (BlobMetaData)

ListSubFolders
Summary: Get subfolders of a folder

2112 | P a g e
 Smartsheet

Description: Get subfolders of a folder

Syntax:
Smartsheet.ListSubFolders (string id)

Parameters:
Name Type Summary Required Related
Action
id string The id of the True
(Folder Id) parent folder

Returns:
Type:SmartsheetCollection[Folder]
Description: A common pattern for requesting collections from smartsheet

ListFolder
Summary: Gets a folders items for the file picker
Description: Gets a folders items for the file picker

Syntax:
Smartsheet.ListFolder (string id)

Parameters:
Name Type Summary Required Related
Action
id string The id of the True
(Root parent folder
Folder)

2113 | P a g e
 Smartsheet

Returns:
Type:array of (BlobMetaData)

GetDiscussionsForSheet
Summary: Get discussions for a sheet
Description: Get discussions for a sheet

Syntax:
Smartsheet.GetDiscussionsForSheet (string sheetId)

Parameters:
Name Type Summary Required Related
Action
sheetId string Sheet True
(Sheet Id)

Returns:
Type:SmartsheetCollection[GetDiscussionResponse]
Description: A common pattern for requesting collections from smartsheet

AddDiscussionToSheet
Summary: Add a discussion to a sheet
Description: Add a discussion to a sheet

Syntax:
Smartsheet.AddDiscussionToSheet (string sheetId, Discussion
discussion)

Parameters:

2114 | P a g e
 Smartsheet

Name Type Summary Required Related

Action
sheetId string Sheet to add a True
(Sheet Id) discussion to
discussion Discussion A Smartsheet True
discussion

Returns:
Type:DiscussionResponse
Description: Response object for Create Discussion

AddDiscussionToRow
Summary: Add a discussion to a row
Description: Add a discussion to a row

Syntax:
Smartsheet.AddDiscussionToRow (string sheetId, string rowId,
Discussion discussion)

Parameters:
Name Type Summary Required Related
Action
sheetId string Sheet True
(Sheet)
rowId string Sheet True GetSheet
(Row)
discussion Discussion A Smartsheet True
discussion

2115 | P a g e
 Smartsheet

Returns:
Type:DiscussionResponse
Description: Response object for Create Discussion

AddCommentToDiscussion
Summary: Add a comment to a discussion
Description: Add a comment to a discussion

Syntax:
Smartsheet.AddCommentToDiscussion (string sheetId, string
discussionId, Comment comment)

Parameters:
Name Type Summary Required Related Action
sheetId string Sheet to add True
(Sheet Id) a comment
to
discussionId string Discussion True GetDiscussionsForSheet
(Discussion)
comment Comment A discussion True
comment

Returns:
Type:CreateCommentResponse
Description: Response object for Creating a Comment

GetDiscussion
Summary: Get a discussion
Description: Get a discussion

2116 | P a g e
 Smartsheet

Syntax:
Smartsheet.GetDiscussion (string sheetId, string discussionId)

Parameters:
Name Type Summary Required Related Action
sheetId string Sheet to get True
(Sheet Id) the
discussion
from
discussionId string Discussion True GetDiscussionsForSheet
(Discussion to get
Id)

Returns:
Type:DiscussionData
Description: Data relevant to the discussion created

Triggers:
Trigger OnNewSheet
Summary: When a new sheet is created
Description: When a new sheet is created

Syntax:
Smartsheet.OnNewSheet ([Optional]string optionalFolderId)

Parameters:

2117 | P a g e
 Smartsheet

Name Type Summary Required Related

Action
optionalFolderId string Folder id for the False
(Optional folder containing
folder to the sheets
look in for
new sheets
(defaults to
all))

Returns:
Type:SmartsheetCollection[Sheet]
Description: A common pattern for requesting collections from smartsheet

Trigger OnUpdatedSheet
Summary: When any sheet is updated
Description: When any sheet is updated

Syntax:
Smartsheet.OnUpdatedSheet ([Optional]string optionalFolderId)

Parameters:
Name Type Summary Required Related
Action
optionalFolderId string Folder id for the False
(Optional folder containing
folder to the sheets
look in for
updated

2118 | P a g e
 Smartsheet

sheets
(defaults to
all))

Returns:
Type:SmartsheetCollection[Sheet]
Description: A common pattern for requesting collections from smartsheet

Trigger OnNewComment
Summary: When a comment is added to a sheet
Description: When a comment is added to a sheet

Syntax:
Smartsheet.OnNewComment (string sheetId)

Parameters:
Name Type Summary Required Related
Action
sheetId string The sheet to get True
(Sheet Id)

Returns:
Type:SmartsheetCollection[DiscussionComment]
Description: A common pattern for requesting collections from smartsheet

Trigger OnUpdatedSpecificSheet
Summary: When a specific sheet is updated
Description: When a specific sheet is updated

2119 | P a g e
 Smartsheet

Syntax:
Smartsheet.OnUpdatedSpecificSheet (string sheetId,
[Optional]string columns)

Parameters:
Name Type Summary Required Related
Action
sheetId string The sheet to True
(Sheet Id) watch for
updates
columns string The list of False
(Comma columns to
separated return
columns to
return)

Returns:
Type:SmartsheetCollection[SheetWithRows]
Description: A common pattern for requesting collections from smartsheet

Trigger OnRowCreated
Summary: When a new row is created
Description: When a new row is created

Syntax:
Smartsheet.OnRowCreated (string sheetId, [Optional]string
columns)

Parameters:

2120 | P a g e
 Smartsheet

Name Type Summary Required Related

Action
sheetId string The sheet to get True
(Sheet Id) the columns for
columns string The list of False
(Comma columns to
separated return
columns to
return)

Returns:
Type:RowResponse
Description: Response object for OnRowCreated

Trigger OnCommentAdded
Summary: When a comment is added to a discussion
Description: When a comment is added to a discussion

Syntax:
Smartsheet.OnCommentAdded (string sheetId, string discussionId)

Parameters:
Name Type Summary Required Related Action
sheetId string Sheet to True
(Sheet Id) look for a
discussion
on

2121 | P a g e
 Smartsheet

discussionId string Discussion to True GetDiscussionsForSheet

(Discussion watch for
Id) comments

Returns:
Type:CommentResponse
Description: Response object for Comment

Trigger OnDiscussionCreated
Summary: When a discussion is added to a sheet
Description: When a discussion is added to a sheet

Syntax:
Smartsheet.OnDiscussionCreated (string sheetId)

Parameters:
Name Type Summary Required Related
Action
sheetId string Sheet True
(Sheet Id)

Returns:
Type:SmartsheetCollection[GetDiscussionResponse]
Description: A common pattern for requesting collections from smartsheet

2122 | P a g e
 Smartsheet

BlobMetaData
Summary:
Description: Metadata for Smartsheet Blobs

Properties:
Name Type Summary
Id string The unique identifier for
Id the file or folder
Name string The name of the file or
Name folder
DisplayName string The display name of the
Name file or folder
Path string The path of the file or
Path folder
LastModified string(date-time) The last modified date of
Name the file or folder
Size integer(int64) The size of the file or
Size folder
MediaType string The MIME media type of
Media Type the file
IsFolder boolean Indicates whether the
Is Folder item is a folder
ETag string The ETag, a token used
ETag for syncing
FileLocator string The file locator (unknown
File locator use)

2123 | P a g e
 Smartsheet

Column
Summary:
Description: A Smartsheet column

Properties:
Name Type Summary
id integer(int64) The unique id of the
Column Id column
index integer(int32) The ordinal position of the
Column index column
title string The title of the column
Title
type string Column data type
Data type
primary boolean Indicates whether the
Is primary column is the primary
column
width integer(int32) The width in pixels of the
Width column

2124 | P a g e
 Smartsheet

Comment
Summary:
Description: A discussion comment

Properties:
Name Type Summary
text string Text of the comment
Text

2125 | P a g e
 Smartsheet

CommentResponse
Summary:
Description: Response object for Comment

Properties:
Name Type Summary
comments array of Comments in this
(DiscussionComment) discussion
Comments

2126 | P a g e
 Smartsheet

CreateCommentResponse
Summary:
Description: Response object for Creating a Comment

Properties:
Name Type Summary
result DiscussionComment A comment on a
discussion

2127 | P a g e
 Smartsheet

Discussion
Summary:
Description: A Smartsheet discussion

Properties:
Name Type Summary
title string Title for the discussion
Title
comment Comment A discussion comment

2128 | P a g e
 Smartsheet

DiscussionComment
Summary:
Description: A comment on a discussion

Properties:
Name Type Summary
text string Text of this comment
Text of Comment
id integer(int32) Id for this comment
Id of Comment
createdBy DiscussionCommentUser User who created a
comment
createdAt string(date-time) Date this comment was
Time comment created created
modifiedAt string(date-time) Date this comment was
Time comment modified modified

2129 | P a g e
 Smartsheet

DiscussionCommentUser
Summary:
Description: User who created a comment

Properties:
Name Type Summary
name string Name of the user who
Comment created by created a comment
name
email string Email of the user who
Comment created by created a comment
email

2130 | P a g e
 Smartsheet

DiscussionData
Summary:
Description: Data relevant to the discussion created

Properties:
Name Type Summary
id integer(int32) Id for this discussion
Id of Discussion
title string Title for the discussion
Discussion title
comments array of Comments in this
(DiscussionComment) discussion
Comments
createdBy DiscussionUser User who created this
discussion

2131 | P a g e
 Smartsheet

DiscussionResponse
Summary:
Description: Response object for Create Discussion

Properties:
Name Type Summary
result DiscussionData Data relevant to the
discussion created

2132 | P a g e
 Smartsheet

DiscussionUser
Summary:
Description: User who created this discussion

Properties:
Name Type Summary
name string Name of the user who
Discussion created by created this discussion
name
email string Email of the user who
Discussion created by created this discussion
email

2133 | P a g e
 Smartsheet

Folder
Summary:
Description: A Smartsheet folder

Properties:
Name Type Summary
id string The unique id of the folder
Id
name string The name of the folder
Name
permalink string The url for the folder
Url

2134 | P a g e
 Smartsheet

GetDiscussionResponse
Summary:
Description: Response object for Get Discussions

Properties:
Name Type Summary
id integer(int32) Unique id of the
Id of Discussion discussion
title string Title for the discussion
Discussion title
createdBy DiscussionUser User who created this
discussion
accessLevel string Access Level for this
Access level of Discussion discussion
parentType string Parent type for this
Parent type of Discussion discussion
readOnly boolean Whether this discussion
Discussion is read only is read-only
lastCommentedAt string(date-time) Date of the most recent
Last commented at comment

2135 | P a g e
 Smartsheet

InsertRowResponse
Summary:
Description: Response to InsertRow operation

Properties:
Name Type Summary
result InsertRowResponseResult Result of inserted row

2136 | P a g e
 Smartsheet

InsertRowResponseResult
Summary:
Description: Result of inserted row

Properties:
Name Type Summary
sheetId integer(int32) The Id of the sheet that
Sheet Id was modified
rowNumber integer(int32) The row number of the
Row number newly inserted row
createdAt string(date-time) When the sheet was
Created at created
modifiedAt string(date-time) When the sheet was
Modified at modified

2137 | P a g e
 Smartsheet

RowCell
Summary:
Description: A cell in a row

Properties:
Name Type Summary
columnId string Column Id
Id of column for this cell
value string Cell value
Cell value
displayValue string Cell display value
Cell display value

2138 | P a g e
 Smartsheet

RowData
Summary:
Description: A row

Properties:
Name Type Summary
id string Id for this row
Id of Row
sheetId string The id of the sheet the
The id of the sheet row was added to
permalink string The url for the sheet the
Url row was added to
createdAt string(date-time) Date this row was created
Time row created
modifiedAt string(date-time) Date this row was
Time row modified modified
rowNumber integer(int32) Row number
Row number
cells array of (RowCell) Cells
Cells
rowHTML string An HTML table
Row HTML representation of the new
row

2139 | P a g e
 Smartsheet

RowPost
Summary:
Description: An object that represents the posting of a row

Properties:
Name Type Summary

2140 | P a g e
 Smartsheet

RowResponse
Summary:
Description: Response object for OnRowCreated

Properties:
Name Type Summary
rows array of (RowData) rows
Rows

2141 | P a g e
 Smartsheet

Sheet
Summary:
Description: A Smartsheet sheet

Properties:
Name Type Summary
accessLevel string The access level of the
Access level sheet
id integer(int32) The unique identifier for
Id the sheet
name string The name of the sheet
Name
permalink string The url for the sheet
Url
createdAt string(date-time) When the sheet was
Created At created
modifiedAt string(date-time) When the sheet was
Modified At modified

2142 | P a g e
 Smartsheet

SheetWithRows
Summary:
Description: A Smartsheet with rows

Properties:
Name Type Summary
rowHTML string An HTML table
Sheet HTML representation of the
sheet
accessLevel string The access level of the
Access level sheet
id integer(int32) The unique identifier for
Id the sheet
name string The name of the sheet
Name
permalink string The url for the sheet
Url
createdAt string(date-time) When the sheet was
Created At created
modifiedAt string(date-time) When the sheet was
Modified At modified

2143 | P a g e
 Smartsheet

SmartsheetCollection[Column]
Summary:
Description: A common pattern for requesting collections from smartsheet

Properties:
Name Type Summary
data array of (Column) Collection of smartsheet
Data models

2144 | P a g e
 Smartsheet

SmartsheetCollection[DiscussionComment]
Summary:
Description: A common pattern for requesting collections from smartsheet

Properties:
Name Type Summary
data array of Collection of smartsheet
(DiscussionComment) models
Data

2145 | P a g e
 Smartsheet

SmartsheetCollection[Folder]
Summary:
Description: A common pattern for requesting collections from smartsheet

Properties:
Name Type Summary
data array of (Folder) Collection of smartsheet
Data models

2146 | P a g e
 Smartsheet

SmartsheetCollection[GetDiscussionResponse]
Summary:
Description: A common pattern for requesting collections from smartsheet

Properties:
Name Type Summary
data array of Collection of smartsheet
(GetDiscussionResponse) models
Data

2147 | P a g e
 Smartsheet

SmartsheetCollection[SheetWithRows]
Summary:
Description: A common pattern for requesting collections from smartsheet

Properties:
Name Type Summary
data array of (SheetWithRows) Collection of smartsheet
Data models

2148 | P a g e
 Smartsheet

SmartsheetCollection[Sheet]
Summary:
Description: A common pattern for requesting collections from smartsheet

Properties:
Name Type Summary
data array of (Sheet) Collection of smartsheet
Data models

2149 | P a g e
 SMTP

SMTP
Connect to SMTP to send email.

Status: Production Tier: Standard Version: 1.0

Actions:
Name Summary
SendEmail (Email Send Email
emailMessage)
SendEmailV2 (EmailV2 Send Email (V2)
emailMessage)
TestConnection () Test connection

Triggers:
Name Summary

Objects:
Name Summary
Attachment
AttachmentV2
Email
EmailV2

Actions:
SendEmail
Summary: Send Email
Description: This operation sends an email to one or more recipients.

2150 | P a g e
 SMTP

Syntax:
SMTP.SendEmail (Email emailMessage)

Parameters:
Name Type Summary Required Related
Action
emailMessage Email SMTP Email True

Returns:
Type:string

SendEmailV2
Summary: Send Email (V2)
Description: This operation sends an email to one or more recipients.

Syntax:
SMTP.SendEmailV2 (EmailV2 emailMessage)

Parameters:
Name Type Summary Required Related
Action
emailMessage EmailV2 SMTP email (v2) True

Returns:
Type:string

2151 | P a g e
 SMTP

TestConnection
Summary: Test connection
Description: Test connection

Syntax:
SMTP.TestConnection ()

Returns:

2152 | P a g e
 SMTP

Attachment
Summary:
Description: Email attachment

Properties:
Name Type Summary
FileName string File name
File name
ContentId string Content id
Content id
ContentData string Content data (base64
Content data encoded for streams and
as-is for string)
ContentType string Content type
Content type
ContentTransferEncoding string Content Transfer
Content Transfer Encoding (base64 or
Encoding none)

2153 | P a g e
 SMTP

AttachmentV2
Summary:
Description: Email attachment (V2)

Properties:
Name Type Summary
ContentData string(byte) Content data
Content data
ContentType string Content type
Content type
FileName string File name
File name
ContentId string Content id
Content id

2154 | P a g e
 SMTP

Email
Summary:
Description: SMTP Email

Properties:
Name Type Summary
From string(email) Email address of sender like [email protected]
From
To string(email) Specify email addresses separated by semicolons
To like
[email protected];[email protected]
CC string(email) Specify email addresses separated by semicolons
CC like
[email protected];[email protected]
Subject string Email subject
Subject
Body string Email body
Body
IsHtml boolean Send the email as HTML (true/false)
Is HTML
Bcc string(email) Specify email addresses separated by semicolons
Bcc like
[email protected];[email protected].
Importance string Importance of the email (High, Normal, or Low)
Importance Values: [Normal, Low, High]
Attachments array of Attachments to be sent along with the email
(Attachment)
Attachments

2155 | P a g e
 SMTP

EmailV2
Summary:
Description: SMTP email (v2)

Properties:
Name Type Summary
From string(email) Email address of sender like [email protected]
From
To string(email) Specify email addresses separated by semicolons
To like
[email protected];[email protected]
CC string(email) Specify email addresses separated by semicolons
CC like
[email protected];[email protected]
Subject string Email subject
Subject
Body string Email body
Body
IsHtml boolean Send the email as HTML (true/false)
Is HTML
Bcc string(email) Specify email addresses separated by semicolons
Bcc like
[email protected];[email protected].
Importance string Importance of the email (High, Normal, or Low)
Importance Values: [Normal, Low, High]
Attachments array of Attachments to be sent along with the email
(AttachmentV2)
Attachments

2156 | P a g e
 SparkPost

SparkPost
SparkPost API allows you to manage email recipient lists and send emails.

Status: Preview Tier: Standard Version: 1.0

Actions:
Name Summary
ListRecipientLists () Get all the lists
CreateRecipientList (RecipientList Create recipient list
recipientList)
AddUserToRecipientList (string Add user to recipient list
recipientListId,
AddUserToRecipientListRequest
addUserToRecipientListRequest)
ListTemplates () Get all the stored templates
DeleteUserFromRecipientList (string Delete user from recipient list
recipientListId,
DeleteUserFromRecipientListRequest
deleteUserRequest)
SendEmailToRecipientList Send email to a recipient list
(EmailRecipientListRequest request)
SendEmailToRecipient Send email to a recipient
(EmailRecipientRequest request)

Triggers:
Name Summary
OnNewRecipientList () When a new recipient list is created

2157 | P a g e
 SparkPost

Objects:
Name Summary
Address
AddUserToRecipientListRequest
DeleteUserFromRecipientListRequest
EmailRecipient
EmailRecipientList
EmailRecipientListRequest
EmailRecipientRequest
EmailTemplateList
ListRecipientListsEntry
ListRecipientListsResponse
ListTemplatesEntry
ListTemplatesResponse
Object
Recipient
RecipientList

Actions:
ListRecipientLists
Summary: Get all the lists
Description: Find all the lists for the current user

Syntax:
SparkPost.ListRecipientLists ()

Returns:
Type:ListRecipientListsResponse

2158 | P a g e
 SparkPost

Description: List of this users recipient lists

CreateRecipientList
Summary: Create recipient list
Description: Create recipient list

Syntax:
SparkPost.CreateRecipientList (RecipientList recipientList)

Parameters:
Name Type Summary Required Related
Action
recipientList RecipientList Maintains a list True
of recipients to
whom a
message can be
sent

Returns:
Type:Object

AddUserToRecipientList
Summary: Add user to recipient list
Description: Add user to recipient list

Syntax:
SparkPost.AddUserToRecipientList (string recipientListId,
AddUserToRecipientListRequest addUserToRecipientListRequest)

2159 | P a g e
 SparkPost

Parameters:
Name Type Summa Requir Related
ry ed Action
recipientListId string Select True ListRecipient
(Recipient) a Lists
SparkP
ost
recipie
nt list
addUserToRecipientList AddUserToRecipientList Reques True
Request Request t
templa
te for
adding
a user
to a
recipie
nt list

Returns:
Type:Object

ListTemplates
Summary: Get all the stored templates
Description: Find all the stored templates for the current user

Syntax:
SparkPost.ListTemplates ()

2160 | P a g e
 SparkPost

Returns:
Type:ListTemplatesResponse
Description: List of users store templates.

DeleteUserFromRecipientList
Summary: Delete user from recipient list
Description: Delete user from recipient list

Syntax:
SparkPost.DeleteUserFromRecipientList (string recipientListId,
DeleteUserFromRecipientListRequest deleteUserRequest)

Parameters:
Name Type Summa Requir Related
ry ed Action
recipientListId string Select a True ListRecipientL
(Recipient) SparkP ists
ost
recipien
t list
deleteUserReq DeleteUserFromRecipientListR Reques True
uest equest t
templat
e for
removi
ng a
user to
a

2161 | P a g e
 SparkPost

recipien
t list

Returns:
Type:Object

SendEmailToRecipientList
Summary: Send email to a recipient list
Description: Send email to a recipient list

Syntax:
SparkPost.SendEmailToRecipientList (EmailRecipientListRequest
request)

Parameters:
Name Type Summary Required Related
Action
request EmailRecipientListRequest Request True
object for
email
recipient list
post.

Returns:
Type:Object

SendEmailToRecipient
Summary: Send email to a recipient
Description: Send email to a recipient

2162 | P a g e
 SparkPost

Syntax:
SparkPost.SendEmailToRecipient (EmailRecipientRequest request)

Parameters:
Name Type Summary Required Related
Action
request EmailRecipientRequest Request True
object for
email
recipient post.

Returns:
Type:Object

Triggers:
Trigger OnNewRecipientList
Summary: When a new recipient list is created
Description: When a new recipient list is created

Syntax:
SparkPost.OnNewRecipientList ()

Returns:
Type:ListRecipientListsResponse
Description: List of this users recipient lists

2163 | P a g e
 SparkPost

Address
Summary:
Description: Holds the address for a recipient

Properties:
Name Type Summary
email string Email Address
Email address
name string Name
Name

2164 | P a g e
 SparkPost

AddUserToRecipientListRequest
Summary:
Description: Request template for adding a user to a recipient list

Properties:
Name Type Summary
recipient Recipient Recipient can be sent
emails through Spark Post

2165 | P a g e
 SparkPost

DeleteUserFromRecipientListRequest
Summary:
Description: Request template for removing a user to a recipient list

Properties:
Name Type Summary
email_address string Email address
Email address

2166 | P a g e
 SparkPost

EmailRecipient
Summary:
Description: Recipients to send email to

Properties:
Name Type Summary
address string Email address
Email address

2167 | P a g e
 SparkPost

EmailRecipientList
Summary:
Description: Recipient list to send email to

Properties:
Name Type Summary
list_id string Select a SparkPost
Recipient recipient list

2168 | P a g e
 SparkPost

EmailRecipientListRequest
Summary:
Description: Request object for email recipient list post.

Properties:
Name Type Summary
recipients EmailRecipientList Recipient list to send
email to
content EmailTemplateList List of email templates

campaign_id string Campaign Id

Campaign Id

2169 | P a g e
 SparkPost

EmailRecipientRequest
Summary:
Description: Request object for email recipient post.

Properties:
Name Type Summary
content EmailTemplateList List of email templates

recipients array of (EmailRecipient) Recipients

Recipients

2170 | P a g e
 SparkPost

EmailTemplateList
Summary:
Description: List of email templates

Properties:
Name Type Summary
template_id string Select a SparkPost stored
Template template

2171 | P a g e
 SparkPost

ListRecipientListsEntry
Summary:
Description: A SparkPost RecipientListEntry Object

Properties:
Name Type Summary
id string Identifier of the list
List ID
name string Name of the List
List Name
description string Description of the List
List Description

2172 | P a g e
 SparkPost

ListRecipientListsResponse
Summary:
Description: List of this users recipient lists

Properties:
Name Type Summary
results array of List of recipient lists
(ListRecipientListsEntry)
Recipients

2173 | P a g e
 SparkPost

ListTemplatesEntry
Summary:
Description: A SparkPost ListTemplatesEntry Object

Properties:
Name Type Summary
id string Identifier of the template
Template ID
name string Name of the Template
Template Name
description string Description of the
Template Description Template
published boolean Indicates whether
Published template published or
not.
last_update_time string Last update time of the
Last Update Time Template

2174 | P a g e
 SparkPost

ListTemplatesResponse
Summary:
Description: List of users store templates.

Properties:
Name Type Summary
results array of List of templates
(ListTemplatesEntry)
Templates

2175 | P a g e
 SparkPost

Object
Summary:
Description:

Properties:
Name Type Summary

2176 | P a g e
 SparkPost

Recipient
Summary:
Description: Recipient can be sent emails through Spark Post

Properties:
Name Type Summary
address Address Holds the address for a
recipient

2177 | P a g e
 SparkPost

RecipientList
Summary:
Description: Maintains a list of recipients to whom a message can be sent

Properties:
Name Type Summary
id string Id
Id of the recipient list
name string Name
Name of the recipient list
description string Description
Description
email string Email address
Email address of first
recipient

2178 | P a g e
 Stripe

Stripe
Stripe allows private individuals and businesses to accept payments over the
internet. You can track customers, orders, invoices and more.

Status: Preview Tier: Premium Version: 1.0.0

Actions:
Name Summary
UpdateProduct (string id, Update a product
UpdateProductParameterBody body)
CreateProduct Create a product
(CreateProductParameterBody body)
GetCustomer (string id) Get a customer
UpdateCustomer (string id, Update a customer
[Optional]UpdateCustomerParameterBody
body)
CreateCustomer Create a customer
([Optional]CreateCustomerParameterBody
body)

Triggers:
Name Summary
OnNewCustomer () When a customer is added
OnNewOrder () When an order is added
OnNewCharge () When a charge is added
OnNewInvoiceItem () When an invoice item is added

2179 | P a g e
 Stripe

Objects:
Name Summary
CreateCustomerParameterBody
CreateProductParameterBody
Customer_Response
OnNewChargeResponseItem
OnNewCustomerResponseItem
OnNewInvoiceItemResponseItem
OnNewOrderResponseItem
Product_Response
UpdateCustomerParameterBody
UpdateProductParameterBody

Actions:
UpdateProduct
Summary: Update a product
Description: Updates the specific product by setting the values of the parameters
passed.

Syntax:
Stripe.UpdateProduct (string id, UpdateProductParameterBody
body)

Parameters:
Name Type Summary Required Related
Action

2180 | P a g e
 Stripe

id string The True

(Id) identifier for
the product.
body UpdateProductParameterBody True

Returns:
Type:Product_Response

CreateProduct
Summary: Create a product
Description: Creates a new product.

Syntax:
Stripe.CreateProduct (CreateProductParameterBody body)

Parameters:
Name Type Summary Required Related
Action
body CreateProductParameterBody True

Returns:
Type:Product_Response

GetCustomer
Summary: Get a customer
Description: Returns the details of specified customer.

2181 | P a g e
 Stripe

Syntax:
Stripe.GetCustomer (string id)

Parameters:
Name Type Summary Required Related
Action
id string The id of the True
(Id) customer.

Returns:
Type:Customer_Response

UpdateCustomer
Summary: Update a customer
Description: Updates the specified customer by setting the values of the parameters
passed.

Syntax:
Stripe.UpdateCustomer (string id,
[Optional]UpdateCustomerParameterBody body)

Parameters:
Name Type Summary Required Related
Action
id string The id of True
(Id) the
customer.
body UpdateCustomerParameterBody False

2182 | P a g e
 Stripe

Returns:
Type:Customer_Response

CreateCustomer
Summary: Create a customer
Description: Create a new customer.

Syntax:
Stripe.CreateCustomer ([Optional]CreateCustomerParameterBody
body)

Parameters:
Name Type Summary Required Related
Action
body CreateCustomerParameterBody False

Returns:
Type:Customer_Response

Triggers:
Trigger OnNewCustomer
Summary: When a customer is added
Description: Triggers a new flow when a customer is added.

Syntax:
Stripe.OnNewCustomer ()

2183 | P a g e
 Stripe

Returns:
Type:array of (OnNewCustomerResponseItem)
Description: data

Trigger OnNewOrder
Summary: When an order is added
Description: Triggers a new flow when an order is added.

Syntax:
Stripe.OnNewOrder ()

Returns:
Type:array of (OnNewOrderResponseItem)

Trigger OnNewCharge
Summary: When a charge is added
Description: Triggers a new flow when a charge is added.

Syntax:
Stripe.OnNewCharge ()

Returns:
Type:array of (OnNewChargeResponseItem)
Description: data

Trigger OnNewInvoiceItem
Summary: When an invoice item is added
Description: Triggers a new flow when an invoice item is added.

2184 | P a g e
 Stripe

Syntax:
Stripe.OnNewInvoiceItem ()

Returns:
Type:array of (OnNewInvoiceItemResponseItem)
Description: data

2185 | P a g e
 Stripe

CreateCustomerParameterBody
Summary:
Description:

Properties:
Name Type Summary
description string An arbitrary string that
Description you can attach to a
customer, this will be
unset if you send with an
empty value.
email string The email address of the
Email customer, this will be
unset if you send with an
empty value.

2186 | P a g e
 Stripe

CreateProductParameterBody
Summary:
Description:

Properties:
Name Type Summary
name string The product’s name,
Name meant to be displayable to
the customer.
id string The identifier for the
Id product. Must be unique.
If not provided, an
identifier will be randomly
generated.
active boolean Whether or not the
Active product is currently
available for purchase.
Defaults to true.
caption string A short one-line
Caption description of the product,
meant to be displayable to
the customer.
description string The product’s description,
Description meant to be displayable to
the customer.
images string A list of up to 8 URLs of
Images images for this product,
meant to be displayable to
the customer.

2187 | P a g e
 Stripe

shippable boolean Whether this product is

Shippable shipped (i.e. physical
goods). Defaults to true.
url string A URL of a publicly-
URL accessible webpage for
this product.

2188 | P a g e
 Stripe

Customer_Response
Summary:
Description:

Properties:
Name Type Summary
id string The id of the customer.
Id
account_balance integer(int32) Current balance, if any,
Account Balance being stored on the
customer’s account.
created string(date-time) The datetime the
Created customer was created.
currency string The currency the
Currency customer can be charged
in for recurring billing
purposes.
delinquent boolean Whether or not the latest
Delinquent charge for the customer’s
latest invoice has failed.
description string The description of the
Description customer.
discount string Describes the current
Discount discount active on the
customer, if there is one.
email string The email of the
Email customer.

2189 | P a g e
 Stripe

OnNewChargeResponseItem
Summary:
Description:

Properties:
Name Type Summary
id string The id of the charge.
Id
amount integer(int32) A positive integer in the
Amount smallest currency unit
(e.g., 100 cents to charge
$1.00 or 100 to charge
¥100, a 0-decimal
currency) representing
how much to charge.
amount_refunded integer(int32) Amount in cents
Amount Refunded refunded (can be less
than the amount
attribute on the charge if
a partial refund was
issued).
captured boolean If the charge was created
Captured without capturing, this
boolean represents
whether or not it is still
uncaptured or has since
been captured.
created string(date-time) The datetime the charge
Created was created.

2190 | P a g e
 Stripe

currency string Three-letter ISO currency

Currency code representing the
currency in which the
charge was made.rrency
customer string ID of the customer this
Customer charge is for if one exists.
description string The description of the
Description charge.
failure_code string Error code explaining
Failure Code reason for charge failure
if available.
failure_message string Message to user further
Failure Message explaining reason for
charge failure if available.
invoice string ID of the invoice this
Invoice charge is for if one exists.
order string ID of the order this
Order charge is for if one exists.
outcome Outcome Details about whether or
Outcome not the payment was
accepted, and why.
paid boolean True if the charge
Paid succeeded, or was
successfully authorized
for later capture.
receipt_email string This is the email address
Receipt Email that the receipt for this
charge was sent to.

2191 | P a g e
 Stripe

receipt_number string This is the transaction

Receipt Number number that appears on
email receipts sent for
this charge.
refunded boolean Whether or not the
Refunded charge has been fully
refunded. If the charge is
only partially refunded,
this attribute will still be
false.
statement_descriptor string Extra information about a
Statement Descriptor charge. This will appear
on your customer’s credit
card statement.
status string The status of the
Status payment is either
succeeded, pending, or
failed.

Outcome
Summary: Outcome
Description: Details about whether or not the payment was accepted, and why.

Properties:
Name Type Summary
network_status string Possible values are
Network Status approved_by_network,
declined_by_network,

2192 | P a g e
 Stripe

not_sent_to_network, and
reversed_after_approval.
reason string An enumerated value
Reason indicating a more detailed
explanation of the
outcome’s type.
risk_level string Stripe’s evaluation of the
Risk Level riskiness of the payment.
seller_message string A human-readable
Seller Message description of the outcome
type and reason, designed
for the recipient of the
payment.
type string Possible values are
Type authorized, issuer_declined,
blocked, and invalid.

2193 | P a g e
 Stripe

OnNewCustomerResponseItem
Summary:
Description:

Properties:
Name Type Summary
id string The id of the customer.
Id
account_balance integer(int32) Current balance, if any,
Account Balance being stored on the
customer’s account.
created string(date-time) The datetime the
Created customer was created.
currency string The currency the
Currency customer can be charged
in for recurring billing
purposes.
delinquent boolean Whether or not the latest
Delinquent charge for the customer’s
latest invoice has failed.
description string The description of the
Description customer.
discount string Describes the current
Discount discount active on the
customer, if there is one.
email string The email of the
Email customer.

2194 | P a g e
 Stripe

OnNewInvoiceItemResponseItem
Summary:
Description:

Properties:
Name Type Summary
id string The id of the invoice item.
Id
amount integer(int32) A positive integer in the
Amount smallest currency unit
representing the total
amount for the invoice
item.
currency string 3-letter ISO code
Currency representing the currency
in which the invoice item
was made.
customer string The customer id used for
Customer the invoice item.
date string(date-time) The date of the invoice
Date item.
description string The description of the
description invoice item.
discountable boolean If true, discounts will
Discountable apply to this invoice item.
Always false for
prorations.

2195 | P a g e
 Stripe

invoice string The id of the invoice the

Invoice invoice item was added
to.
plan string If the invoice item is a
Plan proration, the plan of the
subscription that the
proration was computed
for.
proration boolean Whether or not the
Proration invoice item was created
automatically as a
proration adjustment
when the customer
switched plans.
quantity string If the invoice item is a
Quantity proration, the quantity of
the subscription that the
proration was computed
for.
subscription string The subscription that this
Subscription invoice item has been
created for, if any.

2196 | P a g e
 Stripe

OnNewOrderResponseItem
Summary:
Description:

Properties:
Name Type Summary
id string The id of the order.
Id
amount integer(int32) A positive integer in the
Amount smallest currency unit.
amount_returned integer Amount in cents
Amount Returned refunded (can be less
than the amount
attribute on the charge if
a partial refund was
issued).
charge string The ID of the payment
Charge used to pay for the
order. Present if the
order status is paid,
fulfilled, or refunded.
created string(date-time) The datetime the order
Created was created.
currency string 3-letter ISO code
Currency representing the
currency in which the
order was made.
customer string The customer used for
Customer the order.

2197 | P a g e
 Stripe

email string The email address of the

Email customer placing the
order.
selected_shipping_method string The shipping method
Selected Shipping that is currently selected
method for this order, if any.
status string Current order status.
Status One of created, paid,
canceled, fulfilled, or
returned.
updated string(date-time) The datetime the order
Updated was updated.

2198 | P a g e
 Stripe

Product_Response
Summary:
Description:

Properties:
Name Type Summary
id string The id of the product.
Id
active boolean Whether or not the
Active product is currently
available for purchase.
caption string A short one-line
Caption description of the product,
meant to be displayable to
the customer.
created string(date-time) the datetime the product
Created was created at.
description string The product’s description,
Description meant to be displayable to
the customer.
images array of (string) A list of up to 8 URLs of
Images images for this product,
meant to be displayable to
the customer.
name string The product’s name,
Name meant to be displayable to
the customer.
shippable boolean Whether this product is a
Shippable shipped good.

2199 | P a g e
 Stripe

updated string(date-time) The datetime the product

Updated was updated.
url string A URL of a publicly-
URL accessible webpage for
this product.

2200 | P a g e
 Stripe

UpdateCustomerParameterBody
Summary:
Description:

Properties:
Name Type Summary
description string An arbitrary string that
Description you can attach to a
customer, this will be
unset if you send with an
empty value.
email string The email address of the
Email customer, this will be
unset if you send with an
empty value.

2201 | P a g e
 Stripe

UpdateProductParameterBody
Summary:
Description:

Properties:
Name Type Summary
name string The product’s name,
Name meant to be displayable to
the customer.
active boolean Whether or not the
Active product is currently
available for purchase.
Defaults to true.
caption string A short one-line
Caption description of the product,
meant to be displayable to
the customer.
description string The product’s description,
Description meant to be displayable to
the customer.
images string A list of up to 8 URLs of
Images images for this product,
meant to be displayable to
the customer.
shippable boolean Whether this product is
Shippable shipped (i.e. physical
goods). Defaults to true.

2202 | P a g e
 Stripe

url string A URL of a publicly-

URL accessible webpage for
this product.

2203 | P a g e
 SurveyMonkey

SurveyMonkey
SurveyMonkey is the world's leading provider of web-based survey solutions.
These solutions are used by companies, organizations, and individuals to
gather the insights they need to make more informed decisions.

Status: Preview Tier: Premium Version: 1.0

Actions:
Name Summary
GetSurveys () List surveys
GetSurveyCollector (string collectorId) Get a collector
GetSurveyMessages (string collectorId) Get messages
GetSurveyCollectors (string surveyId) List collectors
GetSurvey (string surveyId) Get a survey
SendMessage (string surveyId, string Schedule an existing invite message
collectorId, string messageId,
[Optional]SendMessageParameterBody
body)

Triggers:
Name Summary
OnSurveyCreated () When a new survey is created
OnSurveyCollectorCreated When a new collector is created
(string surveyId)
OnNewResponseAddedCollector When a new collector response is added
(string surveyId, string
collectorId)

2204 | P a g e
 SurveyMonkey

OnNewResponseAddedSurvey When a new survey response is added

(string surveyId)

Objects:
Name Summary
OnNewResponseAddedCollectorResponseItem
OnSurveyCollectorCreatedResponseItem
OnSurveyCreatedResponseItem
SendMessageParameterBody
Survey
SurveyCollector
SurveyCollectors
SurveyMessageResponse
SurveyMessages
Surveys

Actions:
GetSurveys
Summary: List surveys
Description: List the surveys in the account.

Syntax:
SurveyMonkey.GetSurveys ()

Returns:
Type:Surveys

2205 | P a g e
 SurveyMonkey

GetSurveyCollector
Summary: Get a collector
Description: Get details of a specific collector.

Syntax:
SurveyMonkey.GetSurveyCollector (string collectorId)

Parameters:
Name Type Summary Required Related
Action
collectorId string True
(Collector
Id)

Returns:
Type:SurveyCollector

GetSurveyMessages
Summary: Get messages
Description: Get survey messages for a given survey collector.

Syntax:
SurveyMonkey.GetSurveyMessages (string collectorId)

Parameters:
Name Type Summary Required Related
Action
collectorId string True

2206 | P a g e
 SurveyMonkey

(Collector
Id)

Returns:
Type:SurveyMessages

GetSurveyCollectors
Summary: List collectors
Description: Get a list of collectors for a given survey.

Syntax:
SurveyMonkey.GetSurveyCollectors (string surveyId)

Parameters:
Name Type Summary Required Related
Action
surveyId string Select a survey True GetSurveys
(Survey Id)

Returns:
Type:SurveyCollectors

GetSurvey
Summary: Get a survey
Description: Get details of a specific survey.

Syntax:
SurveyMonkey.GetSurvey (string surveyId)

2207 | P a g e
 SurveyMonkey

Parameters:
Name Type Summary Required Related
Action
surveyId string True
(Survey Id)

Returns:
Type:Survey

SendMessage
Summary: Schedule an existing invite message
Description: Send or schedule to send an existing message to all message recipients.

Syntax:
SurveyMonkey.SendMessage (string surveyId, string collectorId,
string messageId, [Optional]SendMessageParameterBody body)

Parameters:
Name Type Summar Require Related Action
y d
surveyId string Select a True GetSurveys
(Survey Id) survey
collectorI string Select a True GetSurveyCollector
d (Collector Id) collector s
messageI string Select a True GetSurveyMessage
d (Message Id) message s
body SendMessageParameterBod False
y

2208 | P a g e
 SurveyMonkey

Returns:
Type:SurveyMessageResponse

Triggers:
Trigger OnSurveyCreated
Summary: When a new survey is created
Description: Triggers a new flow when a survey is created.

Syntax:
SurveyMonkey.OnSurveyCreated ()

Returns:
Type:array of (OnSurveyCreatedResponseItem)

Trigger OnSurveyCollectorCreated
Summary: When a new collector is created
Description: Triggers a new flow when a collector is created.

Syntax:
SurveyMonkey.OnSurveyCollectorCreated (string surveyId)

Parameters:
Name Type Summary Required Related
Action
surveyId string Select a survey True GetSurveys
(Survey Id)

Returns:
2209 | P a g e
 SurveyMonkey

Type:array of (OnSurveyCollectorCreatedResponseItem)

Trigger OnNewResponseAddedCollector
Summary: When a new collector response is added
Description: Triggers a new flow when a response is added (paid account only).

Syntax:
SurveyMonkey.OnNewResponseAddedCollector (string surveyId,
string collectorId)

Parameters:
Name Type Summary Required Related Action
surveyId string Select a True GetSurveys
(Survey Id) survey
collectorId string Select a True GetSurveyCollectors
(Collector collector
Id)

Returns:
Type:array of (OnNewResponseAddedCollectorResponseItem)

Trigger OnNewResponseAddedSurvey
Summary: When a new survey response is added
Description: Triggers a new flow when a survey response is added (paid account only).

Syntax:
SurveyMonkey.OnNewResponseAddedSurvey (string surveyId)

Parameters:

2210 | P a g e
 SurveyMonkey

Name Type Summary Required Related

Action
surveyId string Select a survey True GetSurveys
(Survey Id)

Returns:
Type:array of (OnNewResponseAddedCollectorResponseItem)

2211 | P a g e
 SurveyMonkey

OnNewResponseAddedCollectorResponseItem
Summary:
Description:

Properties:
Name Type Summary
total_time integer(int32) Total time spent on the
Time Spent response.
href string Survey response link.
Link
ip_address string IP address of responder.
IP Address
id string The response identifier.
Response Id
date_modified string(date-time) The date the response
Modified Date was last modified.
response_status string Status of the response.
Response Status
custom_value string Custom value associated
Custom Value with a response.
analyze_url string Link to the analyze page
Analyze Url to view the response.
recipient_id string The recipient identifier.
Recipient Id
collector_id string The collector identifier.
Collector Id
date_created string(date-time) The date the response
Created Date was created.
survey_id string The survey identifier.

2212 | P a g e
 SurveyMonkey

Survey Id
collection_mode string Response collection
Collection Mode mode.
edit_url string Link to the survey page to
Edit Url edit the response.

2213 | P a g e
 SurveyMonkey

OnSurveyCollectorCreatedResponseItem
Summary:
Description:

Properties:
Name Type Summary
href string Link to survey collector.
Link
id string The collector identifier.
Collector Id
name string The name of the collector.
Name

2214 | P a g e
 SurveyMonkey

OnSurveyCreatedResponseItem
Summary:
Description:

Properties:
Name Type Summary
href string Link to the survey.
Link
id string The survey identifier.
Survey Id
title string The title of the survey.
Title

2215 | P a g e
 SurveyMonkey

SendMessageParameterBody
Summary:
Description:

Properties:
Name Type Summary
scheduled_date string(date-time) Time format: yyyy-MM-
Scheduled date ddTHH:mm:ss.fffZ (2016-
07-20T08:00:59.000Z)

2216 | P a g e
 SurveyMonkey

Survey
Summary:
Description:

Properties:
Name Type Summary
response_count integer(int32) Number of responses
Response Count survey has received.
page_count integer(int32) Number of pages in the
Page Count survey.
id string The survey identifier.
Survey Id
question_count integer(int32) Number of questions in
Question Count survey.
category string Survey category chosen
Survey Category when creating the survey.
preview string Survey preview URL.
Preview Url
language string Survey language.
Language
date_modified string(date-time) The date the survey was
Modified Date last modified.
title string The title of the survey.
Title
analyze_url string The URL for the results of
Analyze Url the survey.
summary_url string The URL for the summary
Summary Url of the survey.

2217 | P a g e
 SurveyMonkey

date_created string(date-time) The date the survey was

Created Date created.
collect_url string Survey collect URL.
Collect Url
edit_url string Survey edit URL.
Edit Url

2218 | P a g e
 SurveyMonkey

SurveyCollector
Summary:
Description:

Properties:
Name Type Summary
status string The status of the survey.
Status
redirect_url string Redirect to this url upon
Survey Redirect Url survey completion.
thank_you_message string Message for thank you
Thank You Message page.
response_count integer(int32) The number of survey
Response Count responses.
closed_page_message string Message shown when a
Closed Message survey is closed.
href string Link to the survey
Link collector.
close_date string Close date of collector.
Close Date
id string The collector identifier.
Collector Id
name string The name of the
Name collector.
date_modified string(date-time) The date the collector
Modified Date was last modified.
edit_response_type string Type of response.
Response Type
sender_email string Collector sender email.

2219 | P a g e
 SurveyMonkey

Sender Email
date_created string(date-time) The date the collector
Created Date was created.
disqualification_message string Message for
Disqualification Date disqualification page.
type string Collector type: 'weblink’
Collector Type or 'email’.

2220 | P a g e
 SurveyMonkey

SurveyCollectors
Summary:
Description:

Properties:
Name Type Summary
data array of (DataItem)

DataItem
Summary:
Description:

Properties:
Name Type Summary
href string Link to collector.
Link
name string The name of the collector.
Name
id string The collector identifier.
Collector Id

2221 | P a g e
 SurveyMonkey

SurveyMessageResponse
Summary:
Description:

Properties:
Name Type Summary
is_scheduled string Link to message results.
Link
scheduled_date string(date-time) Date message was
Scheduled Date scheduled to be sent.
body string The plain text body of the
Message Body email message to be sent
to recipients.
subject string Subject of the email
Subject message to be sent to
recipients.
recipients array of (string) List of recipient ids.
Recipients
recipient_status string The recipient status.
States
type string

2222 | P a g e
 SurveyMonkey

SurveyMessages
Summary:
Description:

Properties:
Name Type Summary
data array of (DataItem)

DataItem
Summary:
Description:

Properties:
Name Type Summary
status string The status of the message.
Message status
href string Link to message.
Link
type string Type of message.
Type
id string The message identifier.
Message Id

2223 | P a g e
 SurveyMonkey

Surveys
Summary:
Description:

Properties:
Name Type Summary
data array of (DataItem)

DataItem
Summary:
Description:

Properties:
Name Type Summary
href string Link to the survey.
Link
id string The survey identifier.
Survey Id
title string The title of the survey.
Title

2224 | P a g e
 Text Analytics

Text Analytics
Microsoft Cognitive Services Text Analytics detects language, sentiment and
more of the text you provide.

Status: Preview Tier: Standard Version: v2.0

Actions:
Name Summary
KeyPhrases Key Phrases
(MultiLanguageInput input)
DetectLanguage Detect Language
(LanguageInput input,
[advanced][Optional]integer
numberOfLanguagesToDetect)
DetectSentiment Detect Sentiment
(MultiLanguageInput input)

Triggers:
Name Summary

Objects:
Name Summary
DetectedLanguageV2
KeyPhraseResult
LanguageInput
LanguageResult
MultiLanguageInput

2225 | P a g e
 Text Analytics

SentimentResult

Actions:
KeyPhrases
Summary: Key Phrases
Description: Returns a list of strings denoting the key talking points in the input text.
Currently, the following languages are supported: English, German, Spanish and
Japanese.

Syntax:
TextAnalytics.KeyPhrases (MultiLanguageInput input)

Parameters:
Name Type Summary Required Related
Action
input MultiLanguageInput True

Returns:
Type:KeyPhraseResult

DetectLanguage
Summary: Detect Language
Description: Returns the detected language and a numeric score between 0 and 1.
Scores close to 1 indicate 100% certainty that the identified language is true. A total of
120 languages are supported.

Syntax:

2226 | P a g e
 Text Analytics

TextAnalytics.DetectLanguage (LanguageInput input,

[advanced][Optional]integer numberOfLanguagesToDetect)

Parameters:
Name Type Summary Required Related
Action
input LanguageInput True

numberOfLanguagesToDetect integer(int32) Number of False

(Number of languages to
languages) detect. Set
to 1 by
default.

Returns:
Type:LanguageResult

DetectSentiment
Summary: Detect Sentiment
Description: Returns a numeric score between 0 and 1. Scores close to 1 indicate
positive sentiment, while scores close to 0 indicate negative sentiment. Currently, the
following languages are supported: English, Spanish, French, Portuguese.

Syntax:
TextAnalytics.DetectSentiment (MultiLanguageInput input)

Parameters:
Name Type Summary Required Related
Action

2227 | P a g e
 Text Analytics

input MultiLanguageInput True

Returns:
Type:SentimentResult

2228 | P a g e
 Text Analytics

DetectedLanguageV2
Summary:
Description:

Properties:
Name Type Summary
name string Long name of a detected
Name language (e.g. English,
French).
iso6391Name string A two letter
Language Code representation of the
detected language
according to the ISO 639-1
standard (e.g. en, fr).
score number(double) A confidence score
Score between 0 and 1. Scores
close to 1 indicate 100%
certainty that the
identified language is true.

2229 | P a g e
 Text Analytics

KeyPhraseResult
Summary:
Description:

Properties:
Name Type Summary
keyPhrases array of (string) A list of representative
Key Phrases words or phrases. The
number of key phrases
returned is proportional to
the number of words in
the input document.
id string Unique document
Id identifier.

2230 | P a g e
 Text Analytics

LanguageInput
Summary:
Description:

Properties:
Name Type Summary
text string Text to analyze
Text

2231 | P a g e
 Text Analytics

LanguageResult
Summary:
Description:

Properties:
Name Type Summary
id string Unique document
Id identifier.
detectedLanguages array of A list of extracted
(DetectedLanguageV2) languages.

2232 | P a g e
 Text Analytics

MultiLanguageInput
Summary:
Description:

Properties:
Name Type Summary
text string Text to analyze
Text
language string This is the 2 letter ISO 639-
Language 1 representation of a
language. For
example, use "en" for
English; "es" for Spanish
etc., Values: [en, es, de, ja]

2233 | P a g e
 Text Analytics

SentimentResult
Summary:
Description:

Properties:
Name Type Summary
score number(double) A decimal number
Score between 0 and 1 denoting
the sentiment of the
document. A score above
0.7 usually refers to a
positive document while a
score below 0.3 normally
has a negative
connotation. Mid values
refer to neutral text.
id string Unique document
Request ID identifier.

2234 | P a g e
 Todoist

Todoist
Todoist is an online task management app and todo list. With Todoist, users
can organize, schedule, maintain and prioritize personal tasks.

Status: Production Tier: Standard Version: 1.1

Actions:
Name Summary
ListProjects () List projects
ListItems () List tasks
ListItemsByProject (string id) List tasks by project
ListLabels () List labels
CreateItem (string project_id, Create a task
CreateItemParameterNewItem
newItem)
UpdateItem (string id, string item_id, Update a task
UpdateItemParameterChangeItem
changeItem)
CreateProject Create a project
(CreateProjectParameterNewProject
newProject)
UpdateProject (string project_id, Update a project
UpdateProjectParameterChangeProject
changeProject)
ShareProject (string project_id, Share a project
ShareProjectParameterShareProject
shareProject)

2235 | P a g e
 Todoist

CreateLabel Create a label

(CreateLabelParameterNewLabel
newLabel)
UpdateLabel (string label_id, Update a label
UpdateLabelParameterChangeLabel
changeLabel)

Triggers:
Name Summary
OnItemCompleted (string When a task is completed
project_id)
OnItemCreated (string When a task is created
project_id)

Objects:
Name Summary
CreateItemParameterNewItem
CreateLabelParameterNewLabel
CreateProjectParameterNewProject
Item
Label
ListItemsByProjectResponse
ListItemsResponse
ListLabelsResponse
ListProjectsResponse
OnItemCompletedResponse
OnItemCreatedResponse
Project

2236 | P a g e
 Todoist

ShareProjectParameterShareProject
UpdateItemParameterChangeItem
UpdateLabelParameterChangeLabel
UpdateProjectParameterChangeProject

Actions:
ListProjects
Summary: List projects
Description: List projects

Syntax:
Todoist.ListProjects ()

Returns:
Type:ListProjectsResponse
Description: A Todoist Projects response object

ListItems
Summary: List tasks
Description: List tasks

Syntax:
Todoist.ListItems ()

Returns:
Type:ListItemsResponse
Description: A Todoist Items response object

2237 | P a g e
 Todoist

ListItemsByProject
Summary: List tasks by project
Description: List tasks by project

Syntax:
Todoist.ListItemsByProject (string id)

Parameters:
Name Type Summary Required Related
Action
id string Project Id True ListProjects
(Project Id)

Returns:
Type:ListItemsByProjectResponse
Description: A Todoist Items response object

ListLabels
Summary: List labels
Description: List labels

Syntax:
Todoist.ListLabels ()

Returns:
Type:ListLabelsResponse
Description: A Todoist Labels response object

2238 | P a g e
 Todoist

CreateItem
Summary: Create a task
Description: Create a task

Syntax:
Todoist.CreateItem (string project_id,
CreateItemParameterNewItem newItem)

Parameters:
Name Type Summary Required Related
Action
project_id string Project Id True ListProjects
(Project Id)
newItem CreateItemParameterNewItem A Todoist True
argument
object for
creating
an Item

Returns:
Type:Item
Description: A Todoist Item Object

UpdateItem
Summary: Update a task
Description: Update a task

Syntax:

2239 | P a g e
 Todoist

Todoist.UpdateItem (string id, string item_id,

UpdateItemParameterChangeItem changeItem)

Parameters:
Name Type Summar Require Related Action
y d
id string Project True ListProjects
(Project Id) Id
item_id string Task Id True ListItemsByProje
(Task Id) ct
changeIte UpdateItemParameterChangeI A True
m tem Todoist
argume
nt
object
for
updatin
g an
item

Returns:
Type:Item
Description: A Todoist Item Object

CreateProject
Summary: Create a project
Description: Create a project

Syntax:

2240 | P a g e
 Todoist

Todoist.CreateProject (CreateProjectParameterNewProject
newProject)

Parameters:
Name Type Summary Required Related
Action
newProject CreateProjectParameterNewProject A Todoist True
argument
object for
creating a
Project

Returns:
Type:Project
Description: A Todoist Project Object

UpdateProject
Summary: Update a project
Description: Update a project

Syntax:
Todoist.UpdateProject (string project_id,
UpdateProjectParameterChangeProject changeProject)

Parameters:
Name Type Summar Require Related
y d Action
project_id string Project True ListProjec
(Project Id) Id ts

2241 | P a g e
 Todoist

changeProje UpdateProjectParameterChangePr A True

ct oject Todoist
argume
nt
object
for
updatin
ga
Project

Returns:
Type:Project
Description: A Todoist Project Object

ShareProject
Summary: Share a project
Description: Share a project

Syntax:
Todoist.ShareProject (string project_id,
ShareProjectParameterShareProject shareProject)

Parameters:
Name Type Summar Require Related
y d Action
project_id string Project True ListProject
(Project Id) Id s
shareProjec ShareProjectParameterShareProje A True
t ct Todoist

2242 | P a g e
 Todoist

argumen
t object
for
sharing a
Project

Returns:
Type:Project
Description: A Todoist Project Object

CreateLabel
Summary: Create a label
Description: Create a label

Syntax:
Todoist.CreateLabel (CreateLabelParameterNewLabel newLabel)

Parameters:
Name Type Summary Required Related
Action
newLabel CreateLabelParameterNewLabel A Todoist True
argument
object for
creating a
Label

Returns:
Type:Label
Description: A Todoist Label Object

2243 | P a g e
 Todoist

UpdateLabel
Summary: Update a label
Description: Update a label

Syntax:
Todoist.UpdateLabel (string label_id,
UpdateLabelParameterChangeLabel changeLabel)

Parameters:
Name Type Summary Require Related
d Action
label_id string Label Id True ListLabel
(Label Id) s
changeLabe UpdateLabelParameterChangeLabe A Todoist True
l l argumen
t object
for
updating
a Label

Returns:
Type:Label
Description: A Todoist Label Object

Triggers:
Trigger OnItemCompleted
Summary: When a task is completed
Description: Triggers a new flow when a task is completed

2244 | P a g e
 Todoist

Syntax:
Todoist.OnItemCompleted (string project_id)

Parameters:
Name Type Summary Required Related
Action
project_id string Project Id True ListProjects
(Project Id)

Returns:
Type:OnItemCompletedResponse
Description: A Todoist Items response object

Trigger OnItemCreated
Summary: When a task is created
Description: Trigers a new flow when a task is created

Syntax:
Todoist.OnItemCreated (string project_id)

Parameters:
Name Type Summary Required Related
Action
project_id string Project Id True ListProjects
(Project Id)

Returns:
Type:OnItemCreatedResponse

2245 | P a g e
 Todoist

Description: A Todoist Items response object

2246 | P a g e
 Todoist

CreateItemParameterNewItem
Summary:
Description: A Todoist argument object for creating an Item

Properties:
Name Type Summary
content string Task title
Task Title
date_string string(date-time) Task Due Date (e.g mm-
Task Due Date dd-yyyy, Today @ 11am,
mm/dd/yyyy)
priority string Number between 1 and 4
Task Priority (4 for very urgent and 1
for natural)
indent string Number between 1 and 4,
Indent where 1 is top-level)
item_order string Number, where the
Order smallest value is top-level

2247 | P a g e
 Todoist

CreateLabelParameterNewLabel
Summary:
Description: A Todoist argument object for creating a Label

Properties:
Name Type Summary
name string Label name
Name
color string Number between 0 and
Label Color 11, or 0 and 21 for
premium users
item_order string Number, where the
Order smallest value is top-level

2248 | P a g e
 Todoist

CreateProjectParameterNewProject
Summary:
Description: A Todoist argument object for creating a Project

Properties:
Name Type Summary
name string Project Name
Project Name
color string Number between 0 and
Project Color 11, or 0 and 21 for
premium users
indent string Number between 1 and 4,
Indent where 1 is top-level)
item_order string Number, where the
Order smallest value is top-level

2249 | P a g e
 Todoist

Item
Summary:
Description: A Todoist Item Object

Properties:
Name Type Summary
content string The title of the task
Task Title
id string The id of the task
Task Id
user_id integer(int32) The owner of the task
Task Owner
project_id string Project where task resides
Project Id
date_lang string The language of the date
Date Language (valid languages are: en,
da, pl, zh, ko, de, pt, ja, it,
fr, sv, ru, es, nl).
due_date_utc string(date-time) The date of the task in the
Task Due Date format Mon 07 Aug 2006
12:34:56 +0000
indent integer(int32) The indent of the task (a
Indent number between 1 and 4,
where 1 is top-level)
priority integer(int32) The priority of the task (a
Task Priority number between 1 and 4,
4 for very urgent and 1 for
natural)

2250 | P a g e
 Todoist

item_order integer(int32) The order of the task

Order inside a project (the
smallest value would
place the task at the top)
day_order integer(int32) The order of the task
DayOrder inside the Today or Next 7
days view (a number,
where the smallest value
would place the task at
the top).
collapsed integer(int32) Whether the task’s sub-
Collapsed tasks are collapsed
(where 1 is true and 0 is
false).
children string Children
Children
assigned_by_uid integer(int32) The id of the user who
Assigner Id assigns the current task.
For shared projects only.
responsible_uid integer(int32) The id of user who is
Assignee Id responsible for
accomplishing the current
task. For shared projects
only.
checked integer(int32) Whether the task is
IsTaskCompleted marked as completed
(where 1 is true and 0 is
false)

2251 | P a g e
 Todoist

in_history integer(int32) Whether the task has

IsTaskInHistory been marked as
completed and is marked
to be moved to history.
is_deleted integer(int32) Whether the task is
IsDeleted marked as deleted (where
1 is true and 0 is false)
is_archived integer(int32) Whether the task is
IsTaskArchived marked as archived
(where 1 is true and 0 is
false)
sync_id integer(int32) A special id for shared
SyncId tasks (a number or null if
not set). Used internally
and can be ignored
date_added string(date-time) The date when the task
Date Created was created

2252 | P a g e
 Todoist

Label
Summary:
Description: A Todoist Label Object

Properties:
Name Type Summary
id integer(int32) The id of the label
Label Id
name string The name of the label
Label Name
color integer(int32) The color of the label (a
Color number between 0 and 7,
or between 0 and 12 for
premium users)
item_order integer(int32) Label’s order in the label
Order list (a number, where the
smallest value is top-level)
is_deleted integer(int32) Whether the label is
IsDeleted marked as deleted (where
1 is true and 0 is false)

2253 | P a g e
 Todoist

ListItemsByProjectResponse
Summary:
Description: A Todoist Items response object

Properties:
Name Type Summary
items array of (Item) A collection of items
Items

2254 | P a g e
 Todoist

ListItemsResponse
Summary:
Description: A Todoist Items response object

Properties:
Name Type Summary
items array of (Item) A collection of items
Items

2255 | P a g e
 Todoist

ListLabelsResponse
Summary:
Description: A Todoist Labels response object

Properties:
Name Type Summary
labels array of (Label) A collection of labels
Labels

2256 | P a g e
 Todoist

ListProjectsResponse
Summary:
Description: A Todoist Projects response object

Properties:
Name Type Summary
projects array of (Project) A collection of projects
Projects

2257 | P a g e
 Todoist

OnItemCompletedResponse
Summary:
Description: A Todoist Items response object

Properties:
Name Type Summary
items array of (Item) A collection of items
Items

2258 | P a g e
 Todoist

OnItemCreatedResponse
Summary:
Description: A Todoist Items response object

Properties:
Name Type Summary
items array of (Item) A collection of items
Items

2259 | P a g e
 Todoist

Project
Summary:
Description: A Todoist Project Object

Properties:
Name Type Summary
id string Id of Project
Project Id
name string Name of Project
Project Name
color integer(int32) Color of Project
Color
shared boolean Is Project Shared
Is Project Shared
is_deleted integer(int32) Is Project Deleted
Is Project Deleted
is_archived integer(int32) Is Project Archived
Is Project Archived

2260 | P a g e
 Todoist

ShareProjectParameterShareProject
Summary:
Description: A Todoist argument object for sharing a Project

Properties:
Name Type Summary
email string Email address of user the
Email project is being shared

2261 | P a g e
 Todoist

UpdateItemParameterChangeItem
Summary:
Description: A Todoist argument object for updating an item

Properties:
Name Type Summary
content string Task Title
Task Title
priority string Number between 1 and 4,
Task Priority 4 for very urgent and 1 for
natural
indent string Number between 1 and 4,
Indent where 1 is top-level)
item_order string Number, where the
Order smallest value is top-level

2262 | P a g e
 Todoist

UpdateLabelParameterChangeLabel
Summary:
Description: A Todoist argument object for updating a Label

Properties:
Name Type Summary
name string Label name
Label Name
color string Number between 0 and
Color 11, or 0 and 21 for
premium users
item_order string Number, where the
Order smallest value is top-level

2263 | P a g e
 Todoist

UpdateProjectParameterChangeProject
Summary:
Description: A Todoist argument object for updating a Project

Properties:
Name Type Summary
name string Name of project
Project Name
color string Number between 0 and
Project Color 11, or 0 and 21 for
premium users
indent string Number between 1 and 4,
Indent where 1 is top-level)
item_order string Number, where the
Order smallest value is top-level

2264 | P a g e
 Toodledo

Toodledo
Toodledo is a powerful online productivity tool. Manage your to-do list by
creating and updating tasks.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
ListTasks ([Optional]integer Get a list of tasks
comp)
CreateTask (NewTask task) Create a task
GetTaskById (integer id) Get task
UpdateTask (Task task) Update task
GetFolders () Get folders

Triggers:
Name Summary
TrigOnNewTask () When a new task is created or updated

Objects:
Name Summary
Folder
NewTask
Task

Actions:
ListTasks
Summary: Get a list of tasks
2265 | P a g e
 Toodledo

Description: Returns a list of tasks (up to 1000 results).

Syntax:
Toodledo.ListTasks ([Optional]integer comp)

Parameters:
Name Type Summary Required Related
Action
comp integer(int32) Set to 0 to find False
(Completed) only
uncompleted
tasks or 1 to find
only completed
tasks. Default
includes both.

Returns:
Type:array of (Task)

CreateTask
Summary: Create a task
Description: Create a new task with the specified fields.

Syntax:
Toodledo.CreateTask (NewTask task)

Parameters:

2266 | P a g e
 Toodledo

Name Type Summary Required Related

Action
task NewTask True

Returns:
Type:Task

GetTaskById
Summary: Get task
Description: Get a task by id.

Syntax:
Toodledo.GetTaskById (integer id)

Parameters:
Name Type Summary Required Related
Action
id integer(int32) The server id True
(Task Id) number for this
task.

Returns:
Type:Task

UpdateTask
Summary: Update task
Description: Update the fields for an existing task.

2267 | P a g e
 Toodledo

Syntax:
Toodledo.UpdateTask (Task task)

Parameters:
Name Type Summary Required Related
Action
task Task True

Returns:
Type:Task

GetFolders
Summary: Get folders
Description: Get a list of folders.

Syntax:
Toodledo.GetFolders ()

Returns:
Type:array of (Folder)

Triggers:
Trigger TrigOnNewTask
Summary: When a new task is created or updated
Description: Triggers a new workflow when a task is created or updated.

Syntax:

2268 | P a g e
 Toodledo

Toodledo.TrigOnNewTask ()

Returns:
Type:array of (Task)

2269 | P a g e
 Toodledo

Folder
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) The id number of the
Id folder.
name string A text string up to 32
Name characters.
archived integer(int32) A boolean value indicating
Archived whether the folder has
been archived.
private integer(int32) A boolean value indicating
Private whether the folder has
been shared with other
people.
order integer(int32) An integer representing
Order the preferred order for
listing folders with 1 being
the top.

2270 | P a g e
 Toodledo

NewTask
Summary:
Description:

Properties:
Name Type Summary
title string A string for the name of
Title the task. Up to 255
characters.
folder integer(int32) The id number of the
Folder Id folder. Omit this field or
set it to 0 to leave the task
unassigned to a folder.
priority integer(int32) An integer that represents
Priority the priority of the task.
note string A text string up to 32,000
Note bytes long. New lines
should be sent as .
duedate string(date-time) A timestamp for when the
Due Date task is due. The time
component of this
timestamp doesn't
matter.
duetime string(date-time) A timestamp for when the
Due Time task is due. If the task
does not have a time set,
then this will be empty.

2271 | P a g e
 Toodledo

Task
Summary:
Description:

Properties:
Name Type Summary
id integer(int32) The server id number for
Id this task.
title string A string for the name of
Title the task.
completed string(date-time) A timestamp for when the
Completed task was completed. If the
task is not completed, the
value will be 0.
duedate string(date-time) A timestamp for when the
Due Date task is due.
duetime string(date-time) A timestamp for when the
Due Time task is due. If the task
does not have a time set,
then this will be empty.
note string A text string up to 32,000
Note bytes long.
priority integer(int32) An integer that represents
Priority the priority.
folder integer(int32) The id number of the
Folder folder. If unassigned to a
folder, the value will be 0.
modified string(date-time) A timestamp for when the
Modified task was last modified.

2272 | P a g e
 Toodledo

2273 | P a g e
 Trello

Trello
Trello gives you perspective over all your projects, at work and at home. It is
an easy, free, flexible, and visual way to manage your projects and organize
anything. Connect to Trello to manage your boards, lists and cards.

Status: Production Tier: Standard Version: 1.0

Actions:
Name Summary
ListCards (string board_id, List the cards in a board
[advanced][Optional]string
actions,
[advanced][Optional]boolean
attachments,
[advanced][Optional]string
attachment_fields,
[advanced][Optional]boolean
stickers,
[advanced][Optional]boolean
members,
[advanced][Optional]string
memeber_fields,
[advanced][Optional]boolean
CheckItemStates,
[advanced][Optional]string
Checklists,
[advanced][Optional]integer
limit,

2274 | P a g e
 Trello

[advanced][Optional]string
since,
[advanced][Optional]string
before,
[advanced][Optional]string
filter,
[advanced][Optional]string
fields)
ListCardsSimple (string A simple version of the list cards API method used
board_id) by dynamic values
GetCard (string board_id, Get a card by Id
string card_id,
[advanced][Optional]string
actions,
[advanced][Optional]boolean
actions_entities,
[advanced][Optional]boolean
actions_display,
[advanced][Optional]integer
actions_limit,
[advanced][Optional]string
action_fields,
[advanced][Optional]string
action_memberCreator_fields,
[advanced][Optional]boolean
attachments,
[advanced][Optional]string
attachement_fields,
[advanced][Optional]boolean

2275 | P a g e
 Trello

members,
[advanced][Optional]string
member_fields,
[advanced][Optional]boolean
membersVoted,
[advanced][Optional]string
memberVoted_fields,
[advanced][Optional]boolean
checkItemStates,
[advanced][Optional]string
checkItemState_fields,
[advanced][Optional]string
checklists,
[advanced][Optional]string
checklist_fields,
[advanced][Optional]boolean
board,
[advanced][Optional]string
board_fields,
[advanced][Optional]boolean
list,
[advanced][Optional]string
list_fields,
[advanced][Optional]boolean
stickers,
[advanced][Optional]string
sticker_fields,
[advanced][Optional]string
fields)

2276 | P a g e
 Trello

UpdateCard (string board_id, Update a card

string card_id, UpdateCard
updateCard)
DeleteCard (string board_id, Delete a card
string card_id)
CreateCard (string board_id, Create a card
CreateCard newCard)
ListBoards List boards
([advanced][Optional]string
filter,
[advanced][Optional]string
fields,
[advanced][Optional]string
actions,
[advanced][Optional]boolean
actions_entities,
[advanced][Optional]integer
actions_limit,
[advanced][Optional]string
actions_format,
[advanced][Optional]string
actions_since,
[advanced][Optional]string
action_fields,
[advanced][Optional]string
memberships,
[advanced][Optional]boolean
organization,
[advanced][Optional]string

2277 | P a g e
 Trello

organization_fields,
[advanced][Optional]string
lists)
ListBoardsSimple () List boards with no parameters
GetBoard (string board_id, Get a board by Id
[advanced][Optional]string
actions,
[advanced][Optional]boolean
action_entities,
[advanced][Optional]boolean
actions_display,
[advanced][Optional]string
actions_format,
[advanced][Optional]string
actions_since,
[advanced][Optional]integer
actions_limit,
[advanced][Optional]string
action_fields,
[advanced][Optional]boolean
action_memeber,
[advanced][Optional]string
action_member_fields,
[advanced][Optional]boolean
action_memberCreator,
[advanced][Optional]string
action_memberCreator_fields,
[advanced][Optional]string
cards,

2278 | P a g e
 Trello

[advanced][Optional]string
card_fields,
[advanced][Optional]boolean
card_attachments,
[advanced][Optional]string
card_attachment_fields,
[advanced][Optional]string
card_checklists,
[advanced][Optional]boolean
card_stickers,
[advanced][Optional]string
boardStarts,
[advanced][Optional]string
labels,
[advanced][Optional]string
label_fields,
[advanced][Optional]integer
labels_limits,
[advanced][Optional]string
lists,
[advanced][Optional]string
list_fields,
[advanced][Optional]string
memberships,
[advanced][Optional]boolean
memberships_member,
[advanced][Optional]string
memberships_member_fields,
[advanced][Optional]string

2279 | P a g e
 Trello

members,
[advanced][Optional]string
member_fields,
[advanced][Optional]string
membersInvited,
[advanced][Optional]string
membersInvited_fields,
[advanced][Optional]string
checklists,
[advanced][Optional]string
checklist_fields,
[advanced][Optional]boolean
organization,
[advanced][Optional]string
organization_fields,
[advanced][Optional]string
organization_memberships,
[advanced][Optional]boolean
myPerfs,
[advanced][Optional]string
fields)
UpdateBoard (string board_id, Update a board
[Optional]UpdateBoard
board)
ListLists (string board_id, List the card lists in a board
[advanced][Optional]string
cards,
[advanced][Optional]string
card_fields,

2280 | P a g e
 Trello

[advanced][Optional]string
filter,
[advanced][Optional]string
fields)
ListListsSimple (string A simple version of list cards to be used by dynamic
board_id) values
GetList (string board_id, string Gets a list by Id
list_id,
[advanced][Optional]string
cards,
[advanced][Optional]string
card_fields,
[advanced][Optional]boolean
board,
[advanced][Optional]string
board_fields,
[advanced][Optional]string
fields)
UpdateList (string board_id, Update a list
string list_id, [Optional]string
name,
[advanced][Optional]string
closed,
[advanced][Optional]string
idBoard,
[advanced][Optional]string
pos,
[advanced][Optional]string
subscribed)

2281 | P a g e
 Trello

ListTeams () List the teams you are a member of

ListTeamMembers (string List the members of a team
teamId)
ListBoardMembers (string List the members of a board
board_id)
GetTeamForBoard (string Get the team for a board
board_id)
ListCardMembers (string List the members for a card
board_id, string card_id)
ListCardComments (string List the comments for a card
board_id, string card_id)
AddCommentToCard (string Add a comment to a card
board_id, string card_id,
CommentPost comment)
AddMemberToCard (string Add a member to a card
board_id, string cardId, string
memberId)
CreateBoard (CreateBoard Create a board
board)
CreateList (CreateList list) Create a list
CloseBoard (string board_id) Close a board

Triggers:
Name Summary
OnNewCardInBoard (string When a new card is added to a board
board_id)
OnNewCardInList (string When a new card is added to a list
board_id, string list_id)

2282 | P a g e
 Trello

Objects:
Name Summary
Badges
Board
Card
Comment
CommentPost
CreateBoard
CreateCard
CreateList
CreateListResponse
Label
List
Member
Membership
Object
Perfs
Team
TeamPreferences
UpdateBoard
UpdateCard

Actions:
ListCards
Summary: List the cards in a board
Description: List the cards in a board

Syntax:

2283 | P a g e
 Trello

Trello.ListCards (string board_id, [advanced][Optional]string

actions, [advanced][Optional]boolean attachments,
[advanced][Optional]string attachment_fields,
[advanced][Optional]boolean stickers,
[advanced][Optional]boolean members, [advanced][Optional]string
memeber_fields, [advanced][Optional]boolean CheckItemStates,
[advanced][Optional]string Checklists,
[advanced][Optional]integer limit, [advanced][Optional]string
since, [advanced][Optional]string before,
[advanced][Optional]string filter, [advanced][Optional]string
fields)

Parameters:
Name Type Summary Required Related Action
board_id string Id of the True ListBoardsSimple
(Board Id) board to
fetch all the
cards
actions string List the False
(Actions) actions to
return.
Specify 'all'
or a comma
seperated
list of valid
values
attachments boolean Show False
(Attachments) attachments
attachment_fields string List the False
(Attachment attachment
fields) fields to

2284 | P a g e
 Trello

return.
Specify 'all'
or a comma
seperated
list of valid
values
stickers boolean Show False
(Stickers) stickers
members boolean Show False
(Members) members
memeber_fields string List the False
(Member fields) member
fields to
return.
Specify 'all'
or a comma
seperated
list of valid
values
CheckItemStates boolean Return the False
(Check card card states
states)
Checklists string Show False
(Checklists)Values: checklists
[all, none]
limit integer(int32) The max False
(Limit) number of
results to
return,

2285 | P a g e
 Trello

between 1
and 1000
since string(date-time) Fetch all False
(Limit) cards after
this date
before string(date-time) Fetch all False
(Before) cards before
this date
filter string Filter the False
(Filter)Values: [all, response
closed, none,
open, visible]
fields string List the card False
(Fields) fields to
return.
Specify 'all'
or a comma
seperated
list of valid
values

Returns:
Type:array of (Card)

ListCardsSimple
Summary: A simple version of the list cards API method used by dynamic values
Description: A simple version of the list cards API method used by dynamic values

Syntax:

2286 | P a g e
 Trello

Trello.ListCardsSimple (string board_id)

Parameters:
Name Type Summary Required Related Action
board_id string Board Id True ListBoardsSimple
(Board Id)

Returns:
Type:array of (Card)

GetCard
Summary: Get a card by Id
Description: Get a card by Id

Syntax:
Trello.GetCard (string board_id, string card_id,
[advanced][Optional]string actions, [advanced][Optional]boolean
actions_entities, [advanced][Optional]boolean actions_display,
[advanced][Optional]integer actions_limit,
[advanced][Optional]string action_fields,
[advanced][Optional]string action_memberCreator_fields,
[advanced][Optional]boolean attachments,
[advanced][Optional]string attachement_fields,
[advanced][Optional]boolean members, [advanced][Optional]string
member_fields, [advanced][Optional]boolean membersVoted,
[advanced][Optional]string memberVoted_fields,
[advanced][Optional]boolean checkItemStates,
[advanced][Optional]string checkItemState_fields,
[advanced][Optional]string checklists,
[advanced][Optional]string checklist_fields,
[advanced][Optional]boolean board, [advanced][Optional]string
board_fields, [advanced][Optional]boolean list,
[advanced][Optional]string list_fields,

2287 | P a g e
 Trello

[advanced][Optional]boolean stickers, [advanced][Optional]string

sticker_fields, [advanced][Optional]string fields)

Parameters:
Name Type Summary Require Related Action
d
board_id string Id of the True ListBoardsSim
(Board Id) board to ple
fetch
cards in
card_id string Id of the True ListCardsSimpl
(Card Id) card to e
fetch
actions string List the False
(Actions) actions to
return.
Specify
'all' or a
comma
seperated
list of valid
values
actions_entities boolean Return False
(Actions action
entities) entities
actions_display boolean Return False
(Actions action
display) displays

2288 | P a g e
 Trello

actions_limit integer(int32) Max False

(Actions limit) number of
actions to
return
action_fields string List of False
(Action fields) action
fields to
return for
each
action.
Specify
'all' or a
comma
seperated
list of valid
values
action_memberCreator_fi string List of False
elds (Member action
creator action member
fields) creator
fields to
return.
Specify
'all' or a
comma
seperated
list of valid
values

2289 | P a g e
 Trello

attachments boolean Return False

(Attachments) attachmen
ts
attachement_fields string List of False
(Attachments attachmen
fields) t fields to
return for
each
attachmen
t. Specify
'all' or a
comma
seperated
list of valid
values
members boolean Return False
(Members) members
member_fields string List of False
(Member fields) member
fields to
return for
each
member.
Specify
'all' or a
comma
seperated
list of valid
values

2290 | P a g e
 Trello

membersVoted boolean Return False

(Voted voted
members) members
memberVoted_fields string List of False
(Voted member voted
fields) member
fields to
return for
each
voted
member.
Specify
'all' or a
comma
seperated
list of valid
values
checkItemStates boolean Return False
(Check item card states
states)
checkItemState_fields string List of False
(Item state state fields
fields) to return
for each of
the card
item state.
Specify
'all' or a
comma

2291 | P a g e
 Trello

seperated
list of valid
values
checklists string Return False
(Checklists)Valu checklists
es: [all = null,
none]
checklist_fields string List of False
(Checklist checklist
fields) fields to
return for
each
checklist.
Specify
'all' or a
comma
seperated
list of valid
values
board boolean Return the False
(Board) board
which the
card
belongs to
board_fields string List the False
(Board fields) board
fields to
return.
Specify

2292 | P a g e
 Trello

'all' or a
comma
seperated
list of valid
values
list boolean Return the False
(List) list which
the card
belongs to
list_fields string List the list False
(List fields) fields to
return.
Specify
'all' or a
comma
seperated
list of valid
values
stickers boolean Return False
(Stickers) stickers
sticker_fields string List the False
(Sticker fields) sticker
fields to
return for
each
sticker.
Specify
'all' or a
comma

2293 | P a g e
 Trello

seperated
list of valid
values
fields string List the False
(Fields) card fields
to return

Returns:
Type:Card
Description: A Trello Card Object

UpdateCard
Summary: Update a card
Description: Update a card

Syntax:
Trello.UpdateCard (string board_id, string card_id, UpdateCard
updateCard)

Parameters:
Name Type Summary Required Related Action
board_id string Id of the True ListBoardsSimple
(Board id) board to fetch
cards from
card_id string Id of the card True ListCardsSimple
(Card id) to update
updateCard UpdateCard Model for True
updating a
card in Trello.

2294 | P a g e
 Trello

Returns:
Type:Card
Description: A Trello Card Object

DeleteCard
Summary: Delete a card
Description: Delete a card

Syntax:
Trello.DeleteCard (string board_id, string card_id)

Parameters:
Name Type Summary Required Related Action
board_id string Id of the board True ListBoardsSimple
(Board Id) to fetch cards
from
card_id string Id of the card True ListCardsSimple
(Card Id) to delete

Returns:
Type:Object

CreateCard
Summary: Create a card
Description: Creates a card

Syntax:
Trello.CreateCard (string board_id, CreateCard newCard)

2295 | P a g e
 Trello

Parameters:
Name Type Summary Required Related Action
board_id string Id of the board True ListBoardsSimple
(Board Id) to create the
card in
newCard CreateCard Model for True
creating a new
card in Trello.

Returns:
Type:Object

ListBoards
Summary: List boards
Description: List boards

Syntax:
Trello.ListBoards ([advanced][Optional]string filter,
[advanced][Optional]string fields, [advanced][Optional]string
actions, [advanced][Optional]boolean actions_entities,
[advanced][Optional]integer actions_limit,
[advanced][Optional]string actions_format,
[advanced][Optional]string actions_since,
[advanced][Optional]string action_fields,
[advanced][Optional]string memberships,
[advanced][Optional]boolean organization,
[advanced][Optional]string organization_fields,
[advanced][Optional]string lists)

Parameters:

2296 | P a g e
 Trello

Name Type Summary Required Related

Action
filter string List filters to False
(Filter) apply to board
results. Specify
'all' or a comma
seperated list of
valid values
fields string List the board False
(Fields) fields to return.
Specify 'all' or a
comma
seperated list of
valid values
actions string List the action False
(Actions) fields to return.
Specify 'all' or a
comma
seperated list of
valid values
actions_entities boolean Return action False
(Action entities
entities)
actions_limit integer(int32) Max number of False
(Action limit) actions to
return
actions_format string Specify the False
(Actions format of the
format)Values:

2297 | P a g e
 Trello

[count, list, actions to

minimal] return
actions_since string(date- Return actions False
time) after the
(Actions since) specified date
action_fields string List the fields of False
(Action fileds) the action to
return. Specify
'all' or a comma
seperated list of
valid values
memberships string Specify False
(Memberships) membership
information to
return
organization boolean Specify to False
(Organization) return
organization
information
organization_fields string List the False
(Organization organization
fields) fields to return.
Specify 'all' or a
comma
seperated list of
valid values
lists string Specify whether False
(Lists) to return lists

2298 | P a g e
 Trello

which belong to
the board

Returns:
Type:array of (Board)

ListBoardsSimple
Summary: List boards with no parameters
Description: A simple version of the list boards API call with no parameters to be used
by dynamic values.

Syntax:
Trello.ListBoardsSimple ()

Returns:
Type:array of (Board)

GetBoard
Summary: Get a board by Id
Description: Get a board by Id

Syntax:
Trello.GetBoard (string board_id, [advanced][Optional]string
actions, [advanced][Optional]boolean action_entities,
[advanced][Optional]boolean actions_display,
[advanced][Optional]string actions_format,
[advanced][Optional]string actions_since,
[advanced][Optional]integer actions_limit,
[advanced][Optional]string action_fields,
[advanced][Optional]boolean action_memeber,
[advanced][Optional]string action_member_fields,

2299 | P a g e
 Trello

[advanced][Optional]boolean action_memberCreator,
[advanced][Optional]string action_memberCreator_fields,
[advanced][Optional]string cards, [advanced][Optional]string
card_fields, [advanced][Optional]boolean card_attachments,
[advanced][Optional]string card_attachment_fields,
[advanced][Optional]string card_checklists,
[advanced][Optional]boolean card_stickers,
[advanced][Optional]string boardStarts,
[advanced][Optional]string labels, [advanced][Optional]string
label_fields, [advanced][Optional]integer labels_limits,
[advanced][Optional]string lists, [advanced][Optional]string
list_fields, [advanced][Optional]string memberships,
[advanced][Optional]boolean memberships_member,
[advanced][Optional]string memberships_member_fields,
[advanced][Optional]string members, [advanced][Optional]string
member_fields, [advanced][Optional]string membersInvited,
[advanced][Optional]string membersInvited_fields,
[advanced][Optional]string checklists,
[advanced][Optional]string checklist_fields,
[advanced][Optional]boolean organization,
[advanced][Optional]string organization_fields,
[advanced][Optional]string organization_memberships,
[advanced][Optional]boolean myPerfs, [advanced][Optional]string
fields)

Parameters:
Name Type Summary Require Related
d Action
board_id string Unique Id True ListBoardsSim
(Board Id) of the ple
board to
get
actions string List the False
(Actions) actions to

2300 | P a g e
 Trello

return.
Specify 'all'
or a
comma
seperated
list of valid
values
action_entities boolean Specify False
(Action entities) whether to
return
action
entities
actions_display boolean Specify False
(Actions whether to
display) return
actions
display
actions_format string Specify the False
(Actions format of
format)Values: the actions
[count = null, to return
list = null,
minimal]
actions_since string(date- Only return False
time) the actions
(Actions since) after this
date
actions_limit integer(int32) Max False
(Actions limit) number of

2301 | P a g e
 Trello

actions to
return
action_fields string List the False
(Action field) fields to
return with
each field.
Specify 'all'
or a
comma
seperated
list of valid
values
action_memeber boolean Specify False
(Action whether to
member) return
action
members
action_member_fields string List the False
(Action member
member fields) fields to
return with
each action
member.
Specify 'all'
or a
comma
seperated
list of valid
values

2302 | P a g e
 Trello

action_memberCreator boolean Specify False

(Action whether to
member return
creator) action
member
creator
action_memberCreator_f string List the False
ields (Action action
member member
creator fields) creator
fields to
return.
Specify 'all'
or a
comma
seperated
list of valid
values
cards string Specify the False
(Cards)Values: cards to
[all = null, return
closed = null,
none = null,
open = null,
visible]
card_fields string List the False
(Card fields) fields to
return for
each card.

2303 | P a g e
 Trello

Specify 'all'
or a
comma
seperated
list of valid
values
card_attachments boolean Specify False
(Card whether to
attachments) return
attachment
s on cards
card_attachment_fields string List the False
(Card attachment
attachment fields to
fields) return for
each
attachment
. Specify
'all' or a
comma
seperated
list of valid
values
card_checklists string Specify the False
(Card checklists
checklists)Valu to return
es: [all = null, for each
none] card

2304 | P a g e
 Trello

card_stickers boolean Specify False

(Card stickers) whether to
return card
stickers
boardStarts string Specify the False
(Board board stars
stars)Values: to return
[mine = null,
none]
labels string Specify the False
(Labels)Values: labels to
[all = null, return
none]
label_fields string List the False
(Label fields) label fields
to return
for each
label.
Specify 'all'
or a
comma
seperated
list of valid
values
labels_limits integer(int32) Max False
(Label limits) number of
labels to
return

2305 | P a g e
 Trello

lists string Specify the False

(Lists)Values: lists to
[all = null, return
closed = null,
none = null,
open]
list_fields string List the list False
(List fields) fields to
return for
each list.
Specify 'all'
or a
comma
seperated
list of valid
values
memberships string List the False
(Memberships) membershi
ps to
return.
Specify 'all'
or a
comma
seperated
list of valid
values
memberships_member boolean Specify False
(Memberships whether to
member) return

2306 | P a g e
 Trello

membershi
p members
memberships_member_f string List the False
ields (Memberships member
member fields) fields to
return for
each
membershi
p member.
Specify 'all'
or a
comma
seperated
list of valid
values
members string List the False
(Members)Valu members
es: [admins = to return.
null, all = null, Specify 'all'
none = null, or a
normal = null, comma
owners] seperated
list of valid
values
member_fields string List the False
(Member member
fields) fields to
return for
each

2307 | P a g e
 Trello

member.
Specify 'all'
or a
comma
seperated
list of valid
values
membersInvited string Specify the False
(Invited invited
members)Value members
s: [admin = null, to return
all = null, none
= null, normal =
null, owners]
membersInvited_fields string List the False
(Invited fields to
member fields) return for
each.
Specify 'all'
or a
comma
seperated
list of valid
values
checklists string Specify the False
(Checklists)Valu checklists
es: [all = null, to return
none]

2308 | P a g e
 Trello

checklist_fields string List the False

(Checklist checklist
fields) fields to
return for
each
checklist.
Specify 'all'
or a
comma
seperated
list of valid
values
organization boolean Specify False
(Organization) whether to
return the
organizatio
n
informatio
n
organization_fields string List the False
(Organization organizatio
fields) n fields to
return for
each
organizatio
n. Specify
'all' or a
comma
seperated

2309 | P a g e
 Trello

list of valid
values
organization_membershi string List the False
ps (Organization organizatio
memberships) n
membershi
ps to
return.
Specify 'all'
or a
comma
seperated
list of valid
values
myPerfs boolean Specify False
(My perfs) whether to
return my
perfs
fields string List the False
(Fields) fields to
return.
Specify 'all'
or a
comma
seperated
list of valid
values

Returns:

2310 | P a g e
 Trello

Type:Board
Description: A Trello Board Object

UpdateBoard
Summary: Update a board
Description: Update a board

Syntax:
Trello.UpdateBoard (string board_id, [Optional]UpdateBoard
board)

Parameters:
Name Type Summary Required Related Action
board_id string The board to True ListBoardsSimple
(Board Id) update
board UpdateBoard A Trello Board False
Object used to
create a board

Returns:
Type:Board
Description: A Trello Board Object

ListLists
Summary: List the card lists in a board
Description: List the card lists in a board

Syntax:

2311 | P a g e
 Trello

Trello.ListLists (string board_id, [advanced][Optional]string

cards, [advanced][Optional]string card_fields,
[advanced][Optional]string filter, [advanced][Optional]string
fields)

Parameters:
Name Type Summary Required Related Action
board_id string Unique Id of True ListBoardsSimple
(Board Id) the board to
fetch lists
cards string Specify the False
(Cards)Values: cards to
[all, closed, return
open, none,
visible]
card_fields string List the card False
(Card fields) fields to
return from.
Specify 'all' or
a comma
seperated list
of valid values
filter string Specify the False
(Filter)Values: filter property
[all, closed, for lists
none, open]
fields string List the fields False
(Fields) to return.
Specify 'all' or

2312 | P a g e
 Trello

a comma
seperated list
of valid values

Returns:
Type:array of (List)

ListListsSimple
Summary: A simple version of list cards to be used by dynamic values
Description: A simple version of list cards to be used by dynamic values

Syntax:
Trello.ListListsSimple (string board_id)

Parameters:
Name Type Summary Required Related Action
board_id string Unique Id of True ListBoardsSimple
(Board Id) the board to
fetch lists

Returns:
Type:array of (List)

GetList
Summary: Gets a list by Id
Description: Gets a list by Id

Syntax:

2313 | P a g e
 Trello

Trello.GetList (string board_id, string list_id,

[advanced][Optional]string cards, [advanced][Optional]string
card_fields, [advanced][Optional]boolean board,
[advanced][Optional]string board_fields,
[advanced][Optional]string fields)

Parameters:
Name Type Summary Required Related Action
board_id string Unique Id of True ListBoardsSimple
(Board Id) the board to
fetch the lists
from
list_id string Unique Id of True ListListsSimple
(List Id) the list to
fetch
cards string Specify the False
(Cards)Values: cards to
[all, closed, return
none, open]
card_fields string List the card False
(Card fields) fields to
return for
each card.
Specify 'all' or
a comma
seperated list
of valid values
board boolean Specify False
(Board) whether to

2314 | P a g e
 Trello

return board
information
board_fields string List the board False
(Board fields) fields to
return. Specify
'all' or a
comma
seperated list
of valid values
fields string List the list False
(List fields) fields to
return. Specify
'all' or a
comma
seperated list
of valid values

Returns:
Type:List
Description: A Trello List Object

UpdateList
Summary: Update a list
Description: Update a list

Syntax:
Trello.UpdateList (string board_id, string list_id,
[Optional]string name, [advanced][Optional]string closed,
[advanced][Optional]string idBoard, [advanced][Optional]string
pos, [advanced][Optional]string subscribed)

2315 | P a g e
 Trello

Parameters:
Name Type Summary Required Related Action
board_id string The board True ListBoardsSimple
(Board Id) the list is on
list_id string The list to True ListListsSimple
(List Id) update
name string New list False
(List Name) name
closed string Whether to False
(Closed)Values: close the list
[true, false]
idBoard string The board False ListBoardsSimple
(Board to move to) to move the
list to
pos string List position False
(List (top,
position)Values: bottom, or
[top, bottom] number)
subscribed string Whether to False
(Subscribed)Values: subscribe to
[true, false] the list

Returns:
Type:CreateList
Description: A Trello List Object

ListTeams
Summary: List the teams you are a member of

2316 | P a g e
 Trello

Description: List the teams you are a member of

Syntax:
Trello.ListTeams ()

Returns:
Type:array of (Team)

ListTeamMembers
Summary: List the members of a team
Description: List the members of a team

Syntax:
Trello.ListTeamMembers (string teamId)

Parameters:
Name Type Summary Required Related
Action
teamId string The unique Id of True ListTeams
(Team Id) the team

Returns:
Type:array of (Member)

ListBoardMembers
Summary: List the members of a board
Description: List the members of a board

Syntax:

2317 | P a g e
 Trello

Trello.ListBoardMembers (string board_id)

Parameters:
Name Type Summary Required Related Action
board_id string The unique Id True ListBoardsSimple
(Board Id) of the board

Returns:
Type:array of (Member)

GetTeamForBoard
Summary: Get the team for a board
Description: Get the team for a board

Syntax:
Trello.GetTeamForBoard (string board_id)

Parameters:
Name Type Summary Required Related Action
board_id string Unique Id of True ListBoardsSimple
(Board Id) the board to
fetch team

Returns:
Type:Team
Description: A Trello Team

ListCardMembers
Summary: List the members for a card

2318 | P a g e
 Trello

Description: List the members for a card

Syntax:
Trello.ListCardMembers (string board_id, string card_id)

Parameters:
Name Type Summary Required Related Action
board_id string The unique id True ListBoardsSimple
(Board Id) of the board to
look for cards
on
card_id string The unique id True ListCardsSimple
(Card Id) of the card

Returns:
Type:array of (Member)

ListCardComments
Summary: List the comments for a card
Description: List the comments for a card

Syntax:
Trello.ListCardComments (string board_id, string card_id)

Parameters:
Name Type Summary Required Related Action
board_id string The unique id True ListBoardsSimple
(Board Id) of the board to

2319 | P a g e
 Trello

look for
comments on
card_id string The unique id True ListCardsSimple
(Card Id) of the card

Returns:
Type:array of (Comment)

AddCommentToCard
Summary: Add a comment to a card
Description: Add a comment to a card

Syntax:
Trello.AddCommentToCard (string board_id, string card_id,
CommentPost comment)

Parameters:
Name Type Summary Required Related Action
board_id string The unique id True ListBoardsSimple
(Board Id) of the board
to add a
comment to
card_id string The unique id True ListCardsSimple
(Card Id) of the card
comment CommentPost The model for True
posting a
comment

Returns:

2320 | P a g e
 Trello

Type:Comment
Description: The model for getting a comment

AddMemberToCard
Summary: Add a member to a card
Description: Add a member to a card

Syntax:
Trello.AddMemberToCard (string board_id, string cardId, string
memberId)

Parameters:
Name Type Summary Required Related Action
board_id string The board True ListBoardsSimple
(Select where the
board to card is from
lookup
members)
cardId string The card to True ListCardsSimple
(Card Id) add a
member to
memberId string The member True ListBoardMembers
(Member to add
Id or
Username)

Returns:
Type:array of (Member)

2321 | P a g e
 Trello

CreateBoard
Summary: Create a board
Description: Create a board

Syntax:
Trello.CreateBoard (CreateBoard board)

Parameters:
Name Type Summary Required Related
Action
board CreateBoard A Trello Board True
Object used to
create a board

Returns:
Type:Board
Description: A Trello Board Object

CreateList
Summary: Create a list
Description: Create a list

Syntax:
Trello.CreateList (CreateList list)

Parameters:
Name Type Summary Required Related
Action

2322 | P a g e
 Trello

list CreateList A Trello List True

Object

Returns:
Type:CreateListResponse
Description: A Trello List Object

CloseBoard
Summary: Close a board
Description: Close a board

Syntax:
Trello.CloseBoard (string board_id)

Parameters:
Name Type Summary Required Related Action
board_id string The uninque id True ListBoardsSimple
(Board Id) of the board to
close

Returns:
Type:Board
Description: A Trello Board Object

Triggers:
Trigger OnNewCardInBoard
Summary: When a new card is added to a board
Description: Triggers a flow when a new card is added to a board

2323 | P a g e
 Trello

Syntax:
Trello.OnNewCardInBoard (string board_id)

Parameters:
Name Type Summary Required Related Action
board_id string Unique Id of True ListBoardsSimple
(Board Id) the board to
fetch cards in

Returns:
Type:array of (Card)

Trigger OnNewCardInList
Summary: When a new card is added to a list
Description: Triggers a flow when a new card is added to a list

Syntax:
Trello.OnNewCardInList (string board_id, string list_id)

Parameters:
Name Type Summary Required Related Action
board_id string Unique Id of True ListBoardsSimple
(Board Id) the board to
fetch cards in
list_id string Unique Id of True ListListsSimple
(List Id) the list to fetch
cards in

Returns:

2324 | P a g e
 Trello

Type:array of (Card)

2325 | P a g e
 Trello

Badges
Summary:
Description: A Trello Badges Object

Properties:
Name Type Summary
Votes integer(int32) Votes on the card badges
Votes
ViewingMemberVoted boolean Whether viewing
Viewing member voted members voted on the
badge
Subscribed boolean Whether you are
Subsribed to badge subscribed to the card
badges
Fogbugz string Fogbugz of the badges
Fogbugz
CheckItems integer(int32) Check items in the badge
Check items
CheckItemsChecked integer(int32) Checked check items in
Checked check items the badge
Comments integer(int32) Comments on the badge
Comments
Attachments integer(int32) Attachments on the
Attachments badges
Description boolean Badge description
Description
Due string(date-time) Due date of the badges
Due date

2326 | P a g e
 Trello

Board
Summary:
Description: A Trello Board Object

Properties:
Name Type Summary
id string Unique Id fo the board
Board Id
closed boolean Is board closed
Is closed
dateLastActivity string(date-time) Date of the last activity on
Date last activity the board
dateLastView string(date-time) Date of the last time the
Date last viewed board is viewed
desc string Description of the board
Board description
idOrganization string Id of the organization
Organization id
invitations array of (string) List of invitations on the
Invitations board
invited boolean Whether you are invited
Invited to the board
labelNames Label A Trello Label Object

memberships array of (Membership) Board memberships

Board memberships
name string Name of the board
Board name
pinned boolean Is board pinned

2327 | P a g e
 Trello

Is board pinned
powerUps array of (string) Board power ups
Powerups
perfs Perfs A Trello Perfs Object

shortLink string Short link of the board

Board short link
shortUrl string Short url to the board
Board short url
starred string Whether the board is
Board starred starred
subscribed string Whether you are
Subscribed to board subscribed to the board
url string Full url of the board
Board url

2328 | P a g e
 Trello

Card
Summary:
Description: A Trello Card Object

Properties:
Name Type Summary
id string Unique Id of the card
Card Id
checkItemStates array of (string) Check item states in the
Check item states card
closed boolean Whether the card is
Card closed closed
dateLastActivity string(date-time) Date of last activity on
Date of last activity the card
desc string Description of the card
Card description
idBoard string Unique Id of the board
Board Id which the card belongs
to
idList string Unique Id of the list
List Id which the card belongs
to
idMembersVoted array of (string) Unique Ids of the voting
Voted member Ids members
idShort integer(int32) Short Id of the card
Card short Id
idAttachmentCover string Unique Id of the
Attachment cover Id attachment cover

2329 | P a g e
 Trello

manualCoverAttachment boolean Is manual cover

Is manual cover attachment
attachment
idLabels array of (string) List of label Ids on the
Label Ids card
name string Name of the card
Card name
pos integer(int32) Card position
Card position
shortLink string Short link to the card
Card short link
badges Badges A Trello Badges Object

due string(date-time) Due date of the card

Card due date
email string Email address associated
Creator email address with the creator of the
card
shortUrl string Short url link to the card
Card short url
subscribed boolean Is subscribed to card
Subscribed to card
url string Full url to the card
Card full url

2330 | P a g e
 Trello

Comment
Summary:
Description: The model for getting a comment

Properties:
Name Type Summary
memberCreator Member A Trello Member Object

text string Text of the comment

Comment Text
date string(date-time) Date the comment was
Date the comment was left
left

2331 | P a g e
 Trello

CommentPost
Summary:
Description: The model for posting a comment

Properties:
Name Type Summary
text string Text of the comment
Comment Text

2332 | P a g e
 Trello

CreateBoard
Summary:
Description: A Trello Board Object used to create a board

Properties:
Name Type Summary
name string Name of the board
Board name
defaultLists string Create default lists
Create default lists Values: [true, false]
desc string Description of the board
Board description
idOrganization string Id of the team
Team id
prefs_permissionLevel string Permission level of the
Permission level board Values: [org,
private, public]
prefs_comments string Comment preferences
Comment preferences Values: [disabled,
members, observers, org,
public]
prefs_invitations string Invitation preferences
Invitation preferences Values: [admins,
members]
prefs_cardCovers string Use card covers Values:
Use card covers [true, false]
prefs_background string Background color Values:
Background color [blue, orange, green, red,

2333 | P a g e
 Trello

purple, pink, lime, sky,

grey]
prefs_voting string Voting power-up
Voting power-up preferences Values:
preferences [disabled, members,
observers, org, public]
prefs_cardAging string Card aging power-up
Card aging power-up preferences Values:
preferences [disabled, pirate, regular]
enable_calendar string Emable calendar power-
Enable calendar power- up Values: [true, false]
up

2334 | P a g e
 Trello

CreateCard
Summary:
Description: Model for creating a new card in Trello.

Properties:
Name Type Summary
idList string Id of the list that the card
Parent list Id should be added to
name string The name of the new card
Card name
desc string The description of the
Card description new card
pos string The position of the card.
Card position Specify top, bottom, or a
positive number Values:
[top, bottom]
idMembers string A comma seperated list of
Member Id member Ids to attach to
the card
idLabels string A comma-separated list of
Label Id labels Ids to attach to the
card
urlSource string Source url of the card. Has
Source url to be a URL starting with
http:// or https:// or null
fileSource string Source file of the card
Source file
idCardSource string The Id of the card to copy
Source card Id into a new card

2335 | P a g e
 Trello

keepFromSource string Properties of the card to

Properties to keep from copy over from the source
source card
due string The due date of the card
Due date

2336 | P a g e
 Trello

CreateList
Summary:
Description: A Trello List Object

Properties:
Name Type Summary
name string Name of the list
List name
idBoard string Unique Id of the board to
Board Id create the list in
pos string The position of the list.
List position Specify top, bottom, or a
positive number Values:
[top, bottom]
idListSource string The id of the list to copy
List source into the new list

2337 | P a g e
 Trello

CreateListResponse
Summary:
Description: A Trello List Object

Properties:
Name Type Summary
id string Unique Id of the list
List Id
name string Name of the list
List name
idBoard string Unique Id of the board the
Board Id list belongs to
pos string The position of the list
List position Values: [top, bottom]

2338 | P a g e
 Trello

Label
Summary:
Description: A Trello Label Object

Properties:
Name Type Summary
green string Green label
Green label
yellow string Yellow label
Yellow label
orange string Orange label
Orange label
red string Red label
Red label
purple string Purple label
Purple label
blue string Blue label
Blue label
sky string Sky blue label
Sky blue label
lime string Lime green label
Lime green label
pink string Pink label
Pink label
black string Black label
Black label

2339 | P a g e
 Trello

List
Summary:
Description: A Trello List Object

Properties:
Name Type Summary
id string Unique Id of the list
List Id
name string Name of the list
List name
closed boolean Whether the list is closed
List is closed
idBoard string Unique Id of the board
Board Id which the list belongs to
pos number(double) The position of the board
List position
subscribed boolean Whether you are
Subscribed to list subscribed to the list
cards array of (Card) List of cards inside the list
Cards in list
board Board A Trello Board Object

2340 | P a g e
 Trello

Member
Summary:
Description: A Trello Member Object

Properties:
Name Type Summary
id string Unique Id of the Member
Member Id
fullName string Full name of the Member
Full name
username string Username of the Member
Username
initials string The initials of the user
Initials

2341 | P a g e
 Trello

Membership
Summary:
Description: A Trello Membership Object

Properties:
Name Type Summary
id string Unique Id of the
Membership Id membership
idMember string Unique Id of the member
Member Id
memberType string Type of member
Member type
unconfirmed boolean Is membership
Unconfirmed membership unconfirmeed

2342 | P a g e
 Trello

Object
Summary:
Description:

Properties:
Name Type Summary

2343 | P a g e
 Trello

Perfs
Summary:
Description: A Trello Perfs Object

Properties:
Name Type Summary
permissionLevel string Permission level
Permission level
voting string Who can vote on the
Voting permission object
comments string Who can comment on
Commenting permission the object
invitations string Who can invite people to
Invitation permission the object
selfJoin boolean Can self join object
Self join permission
cardCovers boolean Have access to card
Can access card covers covers
calendarFeedEnabled boolean Is calendar feed enabled
Is calendar feed enabled
background string Background of the object
Object background
backgroundColor string Background color of the
Object background color object, in hex notation
backgroundImage string Background image of the
Object background image object
backgroundImageScaled string Scaled version of the
Scaled backgorund image background image

2344 | P a g e
 Trello

backgroundTile boolean Background tile of the

Object background tile object
backgroundBrightness string Brightness of the object
Background brightness background
canBePublic boolean Can object be public
Can object be public
canBeOrg boolean Can object be part of the
Can be part of organization
organization
canBePrivate boolean Can object be private
Can object be private
canInvite boolean Can invite
Can invite

2345 | P a g e
 Trello

Team
Summary:
Description: A Trello Team

Properties:
Name Type Summary
id string Unique ID of the team
Team ID
desc string Description of the team
Team description
displayName string Display name of the team
Team display name
idBoards array of (string) The boards assigned to
Board IDs this team
billableMemberCount integer(int32) Number of members in
Member Count this team
memberships array of (Membership) The memberships for this
Memberships team
WebSite string Team website
website
prefs TeamPreferences A Trello Team Preference
Object

2346 | P a g e
 Trello

TeamPreferences
Summary:
Description: A Trello Team Preference Object

Properties:
Name Type Summary
permissionLevel string Permission level
Permission Level

2347 | P a g e
 Trello

UpdateBoard
Summary:
Description: A Trello Board Object used to create a board

Properties:
Name Type Summary
name string Name of the board
Board name
defaultLists string Create default lists
Create default lists Values: [true, false]
desc string Description of the board
Board description
idOrganization string Id of the team
Team id
prefs_permissionLevel string Permission level of the
Permission level board Values: [org,
private, public]
prefs_comments string Comment preferences
Comment preferences Values: [disabled,
members, observers, org,
public]
prefs_invitations string Invitation preferences
Invitation preferences Values: [admins,
members]
prefs_cardCovers string Use card covers Values:
Use card covers [true, false]
prefs_background string Background color Values:
Background color [blue, orange, green, red,

2348 | P a g e
 Trello

purple, pink, lime, sky,

grey]
prefs_voting string Voting power-up
Voting power-up preferences Values:
preferences [disabled, members,
observers, org, public]
prefs_cardAging string Card aging power-up
Card aging power-up preferences Values:
preferences [disabled, pirate, regular]
enable_calendar string Emable calendar power-
Enable calendar power- up Values: [true, false]
up

2349 | P a g e
 Trello

UpdateCard
Summary:
Description: Model for updating a card in Trello.

Properties:
Name Type Summary
name string Updated name of the new
Name card
desc string Updated description of
Description the new card
closed boolean Specify whether the card
Is closed is closed
idMembers string Id of the members to add
Member Ids to the card
idAttachmentCover string Id of the attachemnt to
Cover attachment Ids attach to the card
idBoard string Id of the board to attach
Board Id the card to
idList string Id of the list to attach the
List Id card to
pos string Updated position of the
Position card on the page
due string Updated due date of the
Due date card
subscribed boolean Specify whether to
Subscribed to card subscribe to the card

2350 | P a g e
 Twilio

Twilio
Twilio enables apps to send and receive global SMS, MMS and IP messages.

Status: Production Tier: Standard Version: 1.0

Actions:
Name Summary
ListMessages ([Optional]string To, List Messages
[Optional]string From,
[Optional]string DateSent,
[advanced][Optional]integer
PageSize,
[advanced][Optional]integer Page)
SendMessage Send Text Message (SMS)
(SendMessageRequest
sendMessageRequest)
GetMessage (string MessageId) Get Message
ListIncomingPhoneNumbers List Incoming Phone Numbers
([Optional]string PhoneNumber,
[Optional]string FriendlyName,
[advanced][Optional]integer
PageSize,
[advanced][Optional]string Beta)
AddIncomingNumber Add Incoming Number
(AddIncomingPhoneNumberRequest
addIncomingPhoneNumberRequest)
GetIncomingPhoneNumber (string Get Incoming Phone Number
IncomingPhoneNumberSid)

2351 | P a g e
 Twilio

GetAvailableTollFreeNumbers Get Available Toll Free Numbers

(string IsoCountryCode,
[Optional]string AreaCode,
[Optional]string Contains)
GetAvailableMobileNumbers (string Get Available Mobile Numbers
IsoCountryCode, [Optional]string
AreaCode, [Optional]string Contains,
[advanced][Optional]boolean
SmsEnabled,
[advanced][Optional]boolean
MmsEnabled,
[advanced][Optional]boolean
VoiceEnabled)
GetAvailableLocalNumbers (string Get Available Local Numbers
IsoCountryCode, [Optional]string
AreaCode, [Optional]string Contains,
[advanced][Optional]boolean
SmsEnabled,
[advanced][Optional]boolean
MmsEnabled,
[advanced][Optional]boolean
VoiceEnabled, [Optional]string
NearNumber, [Optional]string
NearLatLong,
[advanced][Optional]string
InPostalCode,
[advanced][Optional]string
InRegion)

2352 | P a g e
 Twilio

ListUsage ([Optional]string Category, List Usage

[advanced][Optional]string
SubResource, [Optional]string
EndDate, [Optional]string StartDate,
[advanced][Optional]integer
PageSize)

Triggers:
Name Summary

Objects:
Name Summary
AddIncomingPhoneNumberRequest
AvailablePhoneNumbers
AvailablePhoneNumberWrapper
Capabilities
IncomingPhoneNumber
IncomingPhoneNumberList
Message
MessageList
SendMessageRequest
UsageRecords

Actions:
ListMessages
Summary: List Messages
Description: Returns a list of messages associated with your account

2353 | P a g e
 Twilio

Syntax:
Twilio.ListMessages ([Optional]string To, [Optional]string From,
[Optional]string DateSent, [advanced][Optional]integer PageSize,
[advanced][Optional]integer Page)

Parameters:
Name Type Summary Require Related Action
d
To string Only show False
(To Phone messages to this
Number) phone number.
From string Only show False ListIncomingPhoneNumber
(From Phone messages from s
Number) this phone
number.
DateSen string(date) Only show False
t (Date Sent) messages sent
on this date (in
GMT format),
given as YYYY-
MM-DD.
Example:
DateSent=2009-
07-06. You can
also specify
inequality, such
as
DateSent<=YYYY
-MM-DD for

2354 | P a g e
 Twilio

messages that
were sent on or
before midnight
on a date, and
DateSent>=YYYY
-MM-DD for
messages sent
on or after
midnight on a
date.
PageSize integer(int32 How many False
) resources to
(Limit) return in each
list page. Default
is 50.
Page integer(int32 Page number. False
) Default is 0.
(Page)

Returns:
Type:MessageList
Description: Response model for List Messages operation

SendMessage
Summary: Send Text Message (SMS)
Description: Send a new message to a mobile number.

Syntax:
Twilio.SendMessage (SendMessageRequest sendMessageRequest)

2355 | P a g e
 Twilio

Parameters:
Name Type Summary Required Related
Action
sendMessageRequest SendMessageRequest Request True
model for
Send
Message
operation

Returns:
Type:Message
Description: Model for Message

GetMessage
Summary: Get Message
Description: Returns a single message specified by the provided Message ID.

Syntax:
Twilio.GetMessage (string MessageId)

Parameters:
Name Type Summary Required Related
Action
MessageId string Message SID True
(Message
SID)

Returns:

2356 | P a g e
 Twilio

Type:Message
Description: Model for Message

ListIncomingPhoneNumbers
Summary: List Incoming Phone Numbers
Description: Returns a list of incoming phone number resources, each representing a
phone number given to your account.

Syntax:
Twilio.ListIncomingPhoneNumbers ([Optional]string PhoneNumber,
[Optional]string FriendlyName, [advanced][Optional]integer
PageSize, [advanced][Optional]string Beta)

Parameters:
Name Type Summary Required Related
Action
PhoneNumber string Only show the False
(Phone incoming phone
Number) number
resources that
match this
pattern. You can
specify partial
numbers and
use '*' as a
wildcard for any
digit.
FriendlyName string Only show the False
incoming phone

2357 | P a g e
 Twilio

(Friendly number
Name) resources with
friendly names
that exactly
match this
name.
PageSize integer(int32) Maximum False
(Limit) number of
results
Beta string Include phone False
(Beta) numbers new to
the Twilio
platform.
Possible values
are either true
or false. Default
is false.

Returns:
Type:IncomingPhoneNumberList
Description: Response model for List Messages operation

AddIncomingNumber
Summary: Add Incoming Number
Description: If a phone number is provided instead, adds a new phone number to your
account. If an area code is provided, adds a random phone number available for the
area depending on the Area Code provided.

Syntax:

2358 | P a g e
 Twilio

Twilio.AddIncomingNumber (AddIncomingPhoneNumberRequest
addIncomingPhoneNumberRequest)

Parameters:
Name Type Summa Requir Relat
ry ed ed
Actio
n
addIncomingPhoneNumber AddIncomingPhoneNumbe Reques True
Request rRequest t
model
for Add
Incomi
ng
Numbe
r
operati
on

Returns:
Type:IncomingPhoneNumber
Description: Incoming Phone Number

GetIncomingPhoneNumber
Summary: Get Incoming Phone Number
Description: Fetches the details of a phone number purchased from Twilio.

Syntax:
Twilio.GetIncomingPhoneNumber (string IncomingPhoneNumberSid)

2359 | P a g e
 Twilio

Parameters:
Name Type Summary Required Related
Action
IncomingPhoneNumberSid string Incoming Phone True
(Incoming number ID
Phone
Number ID)

Returns:
Type:IncomingPhoneNumber
Description: Incoming Phone Number

GetAvailableTollFreeNumbers
Summary: Get Available Toll Free Numbers
Description: Returns a list of toll-free available phone numbers, each representing a
phone number that is currently available for your account

Syntax:
Twilio.GetAvailableTollFreeNumbers (string IsoCountryCode,
[Optional]string AreaCode, [Optional]string Contains)

Parameters:
Name Type Summary Required Related
Action
IsoCountryCode string Iso country code True
(ISO of the Toll Free
Country Numbers
Code)

2360 | P a g e
 Twilio

AreaCode string Area Code of the False

(Area Code) Toll Free
Numbers
Contains string Toll Free False
(Contains) Numbers
Contains a
specific number

Returns:
Type:AvailablePhoneNumberWrapper
Description: Available Phone Numbers

GetAvailableMobileNumbers
Summary: Get Available Mobile Numbers
Description: Returns a list of mobile available phone numbers, each representing a
phone number that is currently available for your account

Syntax:
Twilio.GetAvailableMobileNumbers (string IsoCountryCode,
[Optional]string AreaCode, [Optional]string Contains,
[advanced][Optional]boolean SmsEnabled,
[advanced][Optional]boolean MmsEnabled,
[advanced][Optional]boolean VoiceEnabled)

Parameters:
Name Type Summary Required Related
Action
IsoCountryCode string Iso country code True
of the Mobile
Numbers

2361 | P a g e
 Twilio

(ISO
Country
Code)
AreaCode string Area Code of the False
(Area Code) Toll Free
Numbers
Contains string Mobile Numbers False
(Contains) Contains a
specific number
SmsEnabled boolean Sms Enabled on False
(SMS the numbers?
Enabled)
MmsEnabled boolean Mms Enabled on False
(MMS the numbers?
Enabled)
VoiceEnabled boolean Voice Enabled on False
(Voice the numbers?
Enabled)

Returns:
Type:AvailablePhoneNumberWrapper
Description: Available Phone Numbers

GetAvailableLocalNumbers
Summary: Get Available Local Numbers
Description: Returns a list of local available phone numbers, each representing a
phone number that is currently available for your account

Syntax:

2362 | P a g e
 Twilio

Twilio.GetAvailableLocalNumbers (string IsoCountryCode,

[Optional]string AreaCode, [Optional]string Contains,
[advanced][Optional]boolean SmsEnabled,
[advanced][Optional]boolean MmsEnabled,
[advanced][Optional]boolean VoiceEnabled, [Optional]string
NearNumber, [Optional]string NearLatLong,
[advanced][Optional]string InPostalCode,
[advanced][Optional]string InRegion)

Parameters:
Name Type Summary Required Related
Action
IsoCountryCode string Iso country code True
(ISO Country of the Local
Code) Numbers
AreaCode string Area Code of the False
(Area Code) Toll Free
Numbers
Contains string Local Numbers False
(Contains) Contains a
specific number.
SmsEnabled boolean Sms Enabled on False
(SMS Enabled) the numbers?
MmsEnabled boolean Mms Enabled on False
(MMS Enabled) the numbers?
VoiceEnabled boolean Voice Enabled on False
(Voice Enabled) the numbers?
NearNumber string Given a phone False
(Given a phone number, find a
number, find a geographically

2363 | P a g e
 Twilio

geographically close number

close number within Distance
within Distance miles. Distance
miles. Distance defaults to 25
defaults to 25 miles.
miles.)
NearLatLong string Given a False
(Given a latitude/longitude
latitude/longitude pair lat,long find
pair lat,long find geographically
geographically close numbers
close numbers within Distance
within Distance miles.
miles.)
InPostalCode string Postal code of the False
(In Postal Code) number
InRegion string Number belongs False
(In Region) to which region

Returns:
Type:AvailablePhoneNumberWrapper
Description: Available Phone Numbers

ListUsage
Summary: List Usage
Description: Returns Usage records for usage categories

Syntax:

2364 | P a g e
 Twilio

Twilio.ListUsage ([Optional]string Category,

[advanced][Optional]string SubResource, [Optional]string
EndDate, [Optional]string StartDate, [advanced][Optional]integer
PageSize)

Parameters:
Name Type Summary Required Related
Action
Category string Category of False
(Category) usage
SubResource string Sub Resource False
(Sub
Resource)
EndDate string List usage upto a False
(End Date) given date
StartDate string List usage from False
(Start Date) a given date
PageSize integer(int32) Maximum False
(Max Results) number of
results

Returns:
Type:array of (UsageRecords)

2365 | P a g e
 Twilio

AddIncomingPhoneNumberRequest
Summary:
Description: Request model for Add Incoming Number operation

Properties:
Name Type Summary
PhoneNumber string Phone Number

AreaCode string Area Code

FriendlyName string Friendly Name

2366 | P a g e
 Twilio

AvailablePhoneNumbers
Summary:
Description: Available Phone Numbers

Properties:
Name Type Summary
phone_number string Phone Number

friendly_name string Friendly Name

lata string Local Access Transport

Area
latitude string Latitude

longitude string Longitude

postal_code string Postal Code

rate_center string Rate Center

region string Region

MMS boolean Mms Enabled?

SMS boolean Sms Enabled?

voice boolean Voice Enabled?

2367 | P a g e
 Twilio

AvailablePhoneNumberWrapper
Summary:
Description: Available Phone Numbers

Properties:
Name Type Summary
available_phone_numbers array of
(AvailablePhoneNumbers)

2368 | P a g e
 Twilio

Capabilities
Summary:
Description: Phone Number Capabilities

Properties:
Name Type Summary
mms boolean Mms Enabled?

sms boolean Sms Enabled?

voice boolean Voice Enabled?

2369 | P a g e
 Twilio

IncomingPhoneNumber
Summary:
Description: Incoming Phone Number

Properties:
Name Type Summary
phone_number string Phone Number

friendly_name string Friendly Name

sid string Id

account_sid string Account Sid

date_created string(date-time) Date Created

date_updated string(date-time) Date Updated

capabilities Capabilities Phone Number

Capabilities
status_callback string(uri) The URL that Twilio will
request to pass status
parameters (such as call
ended) to your
application
status_callback_method string The HTTP method Twilio
will use to make requests
to the StatusCallback URL.
Either GET or POST.

2370 | P a g e
 Twilio

api_version string API version

2371 | P a g e
 Twilio

IncomingPhoneNumberList
Summary:
Description: Response model for List Messages operation

Properties:
Name Type Summary
incoming_phone_numbers array of
(IncomingPhoneNumber)

page integer(int32) Page number

page_size integer(int32) Page Size

num_pages integer(int32) Number of Pages

uri string(uri) relative URI for this list

first_page_uri string(uri) relative URI for the

first page
next_page_uri string(uri) relative URI for the
next page

2372 | P a g e
 Twilio

Message
Summary:
Description: Model for Message

Properties:
Name Type Summary
body string Body

from string From Phone Number

to string To Phone Number

status string Status

sid string Message SID

account_sid string Account Sid

api_version string API version

num_segments string Number of Segments

num_media string Number of associated

media files
date_created string(date-time) Date Created

date_sent string(date-time) Sent Date

date_updated string(date-time) Updated Date

2373 | P a g e
 Twilio

direction string Direction

error_code string Error Codes

error_message string Error Messages

price string Price

price_unit string Price Unit

uri string(uri) relative URI for this

resource
subresource_uris array of (string(uri)) relative The URIs for any
subresources
messaging_service_sid string Unique id of the
Messaging Service

2374 | P a g e
 Twilio

MessageList
Summary:
Description: Response model for List Messages operation

Properties:
Name Type Summary
messages array of (Message)

page integer(int32) Page number

page_size integer(int32) Page Size

num_pages integer(int32) Number of Pages

uri string(uri) relative URI for this list

first_page_uri string(uri) relative URI for the first

page
next_page_uri string(uri) relative URI for the next
page
total integer(int32) Total number of
messages
previous_page_uri string(uri) relative URI for the
previous page

2375 | P a g e
 Twilio

SendMessageRequest
Summary:
Description: Request model for Send Message operation

Properties:
Name Type Summary
from string A Twilio phone number
(in E.164 format) or
alphanumeric sender ID
enabled for the type of
message you wish to
send.
to string The destination phone
number. Format with a '+'
and country code e.g.,
+16175551212 (E.164
format).
body string The text of the message
you want to send, limited
to 1600 characters.
media_url array of (string(uri)) List of URIs of media to be
sent
status_callback string(uri) A URL that Twilio will
POST to each time your
message status changes
messaging_service_sid string Unique id of the
Messaging Service
application_sid string SID of Twilio Application
which is configured with

2376 | P a g e
 Twilio

the required Message

status call back
max_price string The total maximum price
limit for the message

2377 | P a g e
 Twilio

UsageRecords
Summary:
Description: Usage Records class

Properties:
Name Type Summary
category string Category

usage string Usage

usage_unit string Usage Unit

description string Description

price number(double) Price

price_unit string Price Unit

count string Count

count_unit string Count Unit

start_date string(date-time) Start Date

end_date string(date-time) End Date

2378 | P a g e
 Twitter

Twitter
Twitter Connection Provider lets you post tweets and get tweets, timeline,
friends and followers from your Twitter account.

Status: Production Tier: Standard Version: 1.0

Actions:
Name Summary
UserTimeline (string Get user timeline
userName,
[advanced][Optional]integer
maxResults)
HomeTimeline Get home timeline
([Optional]integer
maxResults)
SearchTweet (string Search tweets
searchQuery,
[advanced][Optional]integer
maxResults,
[advanced][Optional]string
sinceId)
Followers (string userName, Get followers
[advanced][Optional]integer
maxResults)
MyFollowers Get my followers
([Optional]integer
maxResults)

2379 | P a g e
 Twitter

Following (string userName, Get following

[advanced][Optional]integer
maxResults)
MyFollowing Get my following
([advanced][Optional]integer
maxResults)
User (string userName) Get user
Tweet ([Optional]string Post a tweet
tweetText, [Optional]string
body)

Triggers:
Name Summary
OnNewTweet (string When a new tweet is posted
searchQuery)

Objects:
Name Summary
OriginalTweetModel
OriginalTweetUserDetailsModel
OriginalTweetUserMentionsModel
TriggerBatchResponse[TweetModel]
TweetModel
TweetResponseModel
UserDetailsModel
UserMentionsModel

2380 | P a g e
 Twitter

Actions:
UserTimeline
Summary: Get user timeline
Description: This operation gets a list of the most recent tweets posted by a given
user.

Syntax:
Twitter.UserTimeline (string userName,
[advanced][Optional]integer maxResults)

Parameters:
Name Type Summary Required Related
Action
userName string Twitter handle True
(User name) for the user
maxResults integer(int32) Maximum False
(Maximum number of
results) tweets to return

Returns:
Type:array of (TweetModel)

HomeTimeline
Summary: Get home timeline
Description: This operation gets the most recent tweets and re-tweets posted by me
and my followers.

Syntax:
Twitter.HomeTimeline ([Optional]integer maxResults)

2381 | P a g e
 Twitter

Parameters:
Name Type Summary Required Related
Action
maxResults integer(int32) Maximum False
(Maximum number of
results) tweets to return

Returns:
Type:array of (TweetModel)

SearchTweet
Summary: Search tweets
Description: This operation gets a list of relevant tweets matching the search query.

Syntax:
Twitter.SearchTweet (string searchQuery,
[advanced][Optional]integer maxResults,
[advanced][Optional]string sinceId)

Parameters:
Name Type Summary Required Related
Action
searchQuery string Search term like True
(Search text) "happy hour",
#haiku, love OR
hate

2382 | P a g e
 Twitter

maxResults integer(int32) Maximum False

(Maximum number of
results) tweets to return
sinceId string Return tweets False
(sinceId) after the
specified tweet
ID

Returns:
Type:array of (TweetModel)

Followers
Summary: Get followers
Description: This operation gets the list of users that follow a given user.

Syntax:
Twitter.Followers (string userName, [advanced][Optional]integer
maxResults)

Parameters:
Name Type Summary Required Related
Action
userName string Twitter handle True
(User name) for the user
maxResults integer(int32) Maximum False
(Maximum number of users
results) to return

Returns:

2383 | P a g e
 Twitter

Type:array of (UserDetailsModel)

MyFollowers
Summary: Get my followers
Description: This operation gets the list of users who are following me.

Syntax:
Twitter.MyFollowers ([Optional]integer maxResults)

Parameters:
Name Type Summary Required Related
Action
maxResults integer(int32) Maximum False
(Maximum number of users
results) to get

Returns:
Type:array of (UserDetailsModel)

Following
Summary: Get following
Description: The operation gets the list of people the given user follows.

Syntax:
Twitter.Following (string userName, [advanced][Optional]integer
maxResults)

Parameters:

2384 | P a g e
 Twitter

Name Type Summary Required Related

Action
userName string Twitter handle True
(User name) for the user
maxResults integer(int32) Maximum False
(Maximum number of users
results) to return

Returns:
Type:array of (UserDetailsModel)

MyFollowing
Summary: Get my following
Description: This operation gets the list of users that I am following.

Syntax:
Twitter.MyFollowing ([advanced][Optional]integer maxResults)

Parameters:
Name Type Summary Required Related
Action
maxResults integer(int32) Maximum False
(Maximum number of users
results) to return

Returns:
Type:array of (UserDetailsModel)

2385 | P a g e
 Twitter

User
Summary: Get user
Description: This operation gets the profile details for a given user, such as user name,
description, followers count, and more.

Syntax:
Twitter.User (string userName)

Parameters:
Name Type Summary Required Related
Action
userName string Twitter handle True
(User for the user
name)

Returns:
Type:UserDetailsModel
Description: Twitter user details

Tweet
Summary: Post a tweet
Description: This operation posts a new tweet.

Syntax:
Twitter.Tweet ([Optional]string tweetText, [Optional]string
body)

Parameters:

2386 | P a g e
 Twitter

Name Type Summary Required Related

Action
tweetText string Text to be False
(Tweet text) posted
body string(binary) False

Returns:
Type:TweetResponseModel
Description: Model representing Posted Tweet

Triggers:
Trigger OnNewTweet
Summary: When a new tweet is posted
Description: This operation triggers a flow when a new tweet that matches a given
search query is posted.

Syntax:
Twitter.OnNewTweet (string searchQuery)

Parameters:
Name Type Summary Required Related
Action
searchQuery string Search term like True
(Search "happy hour",
text) #haiku, love OR
hate

Returns:

2387 | P a g e
 Twitter

Type:TriggerBatchResponse[TweetModel]

2388 | P a g e
 Twitter

OriginalTweetModel
Summary:
Description: Representation of original tweet object

Properties:
Name Type Summary
TweetText string Text content of the
Original tweet text original retrieved
tweet
TweetId string Id of the original
Original tweet id tweet
CreatedAt string Time at which
Original tweet created at original tweet was
posted
CreatedAtIso string Time at which
Original tweet created at original tweet was
posted
RetweetCount integer(int32) Total number of
Original tweet retweet count re-tweets for this
original tweet
TweetedBy string User name of the
Original tweet tweeted by person who posted
the original tweet
MediaUrls array of (string) Url of the media
Original tweet media urls posted along with
the original tweet
TweetLanguageCode string Language code for
Original tweet language the original tweet

2389 | P a g e
 Twitter

TweetInReplyToUserId string User Id of the

Original tweet in_reply_to_user_id author of the
tweet that the
current original
tweet is a reply to
Favorited boolean Indicates whether
Original tweet favorited the original tweet
is marked as
favorited
UserMentions array of The list of user
(OriginalTweetUserMentionsModel) mentions
Original tweet user mentions
UserDetails OriginalTweetUserDetailsModel Representation of
a Twitter User's
Details

2390 | P a g e
 Twitter

OriginalTweetUserDetailsModel
Summary:
Description: Representation of a Twitter User's Details

Properties:
Name Type Summary
FullName string Name of the user
Original tweet user full
name
Location string Location of the user
Original tweet user
Location
Id integer(int64) Twitter Id of the user
Original tweet user id
UserName string Screen name of the user
Original tweet user name
FollowersCount integer(int64) Number of followers
Original tweet user
followers count
Description string User description
Original tweet user
Description
StatusesCount integer(int64) User status count
Original tweet user
statuses count
FriendsCount integer(int64) Number of friends
Original tweet user friends
count

2391 | P a g e
 Twitter

FavouritesCount integer(int64) Number of tweets that

Original tweet user the user has favorited
favourites count
ProfileImageUrl string Url of the profile image
Original tweet user profile
image url

2392 | P a g e
 Twitter

OriginalTweetUserMentionsModel
Summary:
Description: The user mentions model. This class contains the details about the screen
names extracted from the tweet.

Properties:
Name Type Summary
Id integer(int64) Twitter Id of the user
Original tweet mentioned
user id
FullName string Full name of the user
Original tweet mentioned
user full name
UserName string Screen name of the user
Original tweet mentioned
user name

2393 | P a g e
 Twitter

TriggerBatchResponse[TweetModel]
Summary:
Description:

Properties:
Name Type Summary
value array of (TweetModel)

2394 | P a g e
 Twitter

TweetModel
Summary:
Description: Representation of Tweet Object

Properties:
Name Type Summary
TweetText string Text content of the
Tweet text tweet
TweetId string Id of the tweet
Tweet id
CreatedAt string Time at which the tweet
Created at was posted
CreatedAtIso string Time at which the tweet
Created at was posted
RetweetCount integer(int32) Total number of re-
Retweet count tweets for the tweet
TweetedBy string Name of the user who
Tweeted by has posted the tweet
MediaUrls array of (string) Url of the media posted
Media urls along with the tweet
TweetLanguageCode string Language code of the
Tweet language tweet
TweetInReplyToUserId string User Id of the author of
in_reply_to_user_id the tweet that the
current tweet is a reply
to
Favorited boolean Indicates whether the
tweet is marked as
favorited or not

2395 | P a g e
 Twitter

UserMentions array of List of users mentioned

(UserMentionsModel) in the tweet
User mentions
OriginalTweet OriginalTweetModel Representation of
original tweet object
UserDetails UserDetailsModel Twitter user details

2396 | P a g e
 Twitter

TweetResponseModel
Summary:
Description: Model representing Posted Tweet

Properties:
Name Type Summary
TweetId string ID of the retrieved tweet
Tweet id

2397 | P a g e
 Twitter

UserDetailsModel
Summary:
Description: Twitter user details

Properties:
Name Type Summary
FullName string Name of the user
Name
Location string Location of the user
Location
Id integer(int64) Twitter Id of the user
User id
UserName string Screen name of the user
User name
FollowersCount integer(int64) Number of followers
Followers count
Description string User description
Description
StatusesCount integer(int64) User status count
Statuses count
FriendsCount integer(int64) Number of friends
Friends count
FavouritesCount integer(int64) Number of tweets that
Favourites count the user has favorited
ProfileImageUrl string Url of the profile image
Profile image url

2398 | P a g e
 Twitter

UserMentionsModel
Summary:
Description: Details for mentioned users

Properties:
Name Type Summary
Id integer(int64) Twitter Id of the user
Mentioned user id
FullName string Full name of the user
Mentioned user full name
UserName string Screen name of the user
Mentioned user name

2399 | P a g e
 Typeform

Typeform
Build beautiful, engaging, and conversational online forms, surveys, quizzes,
landing pages, and much more with Typeform.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
GetSchema (string form_id) Get schema
ListForms () List forms

Triggers:
Name Summary
TrigNewResponse (string When a response is submitted
form_id)

Objects:
Name Summary
Item
ListFormsResponseItem
ResponseList

Actions:
GetSchema
Summary: Get schema
Description: Get schema

Syntax:
2400 | P a g e
 Typeform

Typeform.GetSchema (string form_id)

Parameters:
Name Type Summary Required Related
Action
form_id string Form True ListForms
(Form)

Returns:
Type:string

ListForms
Summary: List forms
Description: List forms

Syntax:
Typeform.ListForms ()

Returns:
Type:array of (ListFormsResponseItem)

Triggers:
Trigger TrigNewResponse
Summary: When a response is submitted
Description: Triggers when a new response is submitted.

Syntax:
Typeform.TrigNewResponse (string form_id)

2401 | P a g e
 Typeform

Parameters:
Name Type Summary Required Related
Action
form_id string Form True ListForms
(Form)

Returns:
Type:ResponseList

2402 | P a g e
 Typeform

Item
Summary:
Description:

Properties:
Name Type Summary
ItemInternalId string

2403 | P a g e
 Typeform

ListFormsResponseItem
Summary:
Description:

Properties:
Name Type Summary
id string
Form ID
name string
Form name

2404 | P a g e
 Typeform

ResponseList
Summary:
Description:

Properties:
Name Type Summary
responses array of (Item)

2405 | P a g e
 Vimeo

Vimeo
Vimeo is a powerful tool for video management, marketing, and analytics all in
one place.

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
ListChannelsFollowed List channels you follow
([internal]string fields)

Triggers:
Name Summary
OnVideoUpload When I upload a new video
([internal]string fields,
[internal]string sort)
OnNewVideoInChannel (string When a video is added to a channel
channelId, [internal]string
fields, [internal]string sort,
[internal]integer per_page)

Objects:
Name Summary
Channel
Video
VideoWithChannelId

2406 | P a g e
 Vimeo

Actions:
ListChannelsFollowed
Summary: List channels you follow
Description: Lists all channels which the authenticated user follows

Syntax:
Vimeo.ListChannelsFollowed ([internal]string fields)

Parameters:
Name Type Summary Required Related
Action
fields string True

Returns:
Type:array of (Channel)

Triggers:
Trigger OnVideoUpload
Summary: When I upload a new video
Description: Triggers a flow when the logged in user uploads a new video

Syntax:
Vimeo.OnVideoUpload ([internal]string fields, [internal]string
sort)

Parameters:

2407 | P a g e
 Vimeo

Name Type Summary Required Related

Action
fields string True

sort string True

Returns:
Type:array of (Video)

Trigger OnNewVideoInChannel
Summary: When a video is added to a channel
Description: Triggers a new flow when a video is added to a channel

Syntax:
Vimeo.OnNewVideoInChannel (string channelId, [internal]string
fields, [internal]string sort, [internal]integer per_page)

Parameters:
Name Type Summary Required Related Action
channelId string Unique ID of True ListChannelsFollowed
(Channel the channel
ID) to watch for
new videos
fields string True

sort string True

per_page integer True

2408 | P a g e
 Vimeo

Returns:
Type:array of (VideoWithChannelId)

2409 | P a g e
 Vimeo

Channel
Summary:
Description: A Vimeo Channel

Properties:
Name Type Summary
idPlusName string id,name

name string Name of the channel

Channel Name
id string ID of the given channel
Channel ID
link string Link to the channel
Channel Link
description string Description of the channel
Channel Description
uri string URI of given channel
Channel URI
created_time string(date-time) The time the channel was
Created Time initially uploaded

2410 | P a g e
 Vimeo

Video
Summary:
Description: A Vimeo video

Properties:
Name Type Summary
name string Name of the video
Video Name
link string Link to the video
Video Link
description string Description of the
Video Description uploaded video
created_time string(date-time) The time the video was
Created Time initially uploaded
modified_time string(date-time) The time the video was
Modified Time last modified
user User

User
Summary:
Description:

Properties:
Name Type Summary
name string Name of the user who
Video Author uploaded the video
link string Link to the user who
Video Author Link uploaded the video

2411 | P a g e
 Vimeo

2412 | P a g e
 Vimeo

VideoWithChannelId
Summary:
Description: A Vimeo video

Properties:
Name Type Summary
name string Name of the video
Video Name
link string Link to the video
Video Link
description string Description of the
Video Description uploaded video
created_time string(date-time) The time the video was
Created Time initially uploaded
modified_time string(date-time) The time the video was
Modified Time last modified
channel_id string ID of the channel this
Channel ID video was added to
channel_name string Name of the channel this
Channel Name video was added to
user User

User
Summary:
Description:

Properties:
Name Type Summary

2413 | P a g e
 Vimeo

name string Name of the user who

Video Author uploaded the video
link string Link to the user who
Video Author Link uploaded the video

2414 | P a g e
 Visual Studio Team Services

Visual Studio Team Services

Visual Studio Team Services provides services for teams to share code, track
work, and ship software - for any language, all in a single package. It's the
perfect complement to your IDE.

Status: Preview Tier: Standard Version: 1.3

Actions:
Name Summary
ListAccounts () List accounts
ListProjects (string account) List projects
ListBuildDefinitions (string List build definitions
account, string project)
ListGitRepositories (string List Git repositories
account, string project)
ListGitRefs (string account, List Git refs
string project, string
repository)
ListTeams (string account, List the teams in a project
string project)
ListTeamMembers (string List the users in a team
account, string project, string
team)
QueueNewBuild (string Queue a new build
account, string project, string
buildDefId,
[Optional]QueueBuildRequest
buildDetails)

2415 | P a g e
 Visual Studio Team Services

CreateWorkItem (string Create a new work item

account, string project, string
type,
CreateWorkItemRequest
workItem)
UpdateWorkItem (string Update a work item
account, string id,
UpdateWorkItemRequest
workItem)
GetColumnsSchema (string Get the schema for dynamic custom fields
numOfCustom)

Triggers:
Name Summary
OnTfvcCheckIn (string account, string When code is checked in (TFVC)
project, [Optional]string team,
[Optional]string author)
OnGitPush (string account, string project, When code is pushed (Git)
string repository, [advanced][Optional]string
refName)
OnBuildCompleted (string account, string When a build completes
project, [Optional]string resultFilter,
[advanced][Optional]string definitions)
OnWorkItemAssigned (string account, string When a work item is assigned
project, [Optional]string team, string
wiql__System_AssignedTo,
[advanced][Optional]string
wiql__System_WorkItemType,

2416 | P a g e
 Visual Studio Team Services

[advanced][Optional]string
wiql__System_AreaPath,
[advanced][Optional]string
wiql__System_IterationPath,
[advanced][Optional]string
wiql__Microsoft_VSTS_Common_Priority,
[advanced][Optional]string
wiql__System_TeamProject,
[advanced][Optional]string
wiql__Microsoft_VSTS_Common_CreatedBy)
OnWorkItemUpdated (string account, string When a work item is updated
project, [Optional]string team,
[Optional]string wiql__System_AssignedTo,
[Optional]string
wiql__System_WorkItemType,
[advanced][Optional]string
wiql__System_AreaPath,
[advanced][Optional]string
wiql__System_IterationPath,
[advanced][Optional]string
wiql__Microsoft_VSTS_Common_Priority,
[advanced][Optional]string
wiql__System_TeamProject,
[advanced][Optional]string
wiql__Microsoft_VSTS_Common_CreatedBy)
OnWorkItemCreated (string account, string When a work item is created
project, [Optional]string team,
[Optional]string wiql__System_AssignedTo,
[Optional]string

2417 | P a g e
 Visual Studio Team Services

wiql__System_WorkItemType,
[advanced][Optional]string
wiql__System_AreaPath,
[advanced][Optional]string
wiql__System_IterationPath,
[advanced][Optional]string
wiql__Microsoft_VSTS_Common_Priority,
[advanced][Optional]string
wiql__System_TeamProject,
[advanced][Optional]string
wiql__Microsoft_VSTS_Common_CreatedBy)

Objects:
Name Summary
Account
BuildDefinition
BuildRequestUser
BuildResult
BuildResultDefinition
ChangesetAuthor
ChangesetCheckedInBy
CreateWorkItemRequest
GitPush
GitPushUser
GitRef
GitRepository
Links
Project

2418 | P a g e
 Visual Studio Team Services

QueueBuildRequest
Team
TeamMember
TfvcChangeset
UpdateWorkItemRequest
VstsList[Account]
VstsList[BuildDefinition]
VstsList[BuildResult]
VstsList[GitPush]
VstsList[GitRef]
VstsList[GitRepository]
VstsList[Project]
VstsList[TeamMember]
VstsList[Team]
VstsList[TfvcChangeset]
VstsList[WorkItemResponse]
WebLinks
WorkItemFields
WorkItemResponse

Actions:
ListAccounts
Summary: List accounts
Description: Retrieves the list of accounts the user is a member of

Syntax:
VisualStudioTeamServices.ListAccounts ()

2419 | P a g e
 Visual Studio Team Services

Returns:
Type:VstsList[Account]
Description: A list of VSTS models

ListProjects
Summary: List projects
Description: Retrieves the list of projects in an account

Syntax:
VisualStudioTeamServices.ListProjects (string account)

Parameters:
Name Type Summary Required Related
Action
account string Choose a VSTS True ListAccounts
(Account account
name)

Returns:
Type:VstsList[Project]
Description: A list of VSTS models

ListBuildDefinitions
Summary: List build definitions
Description: Retrieves the list of build defintions in a project

Syntax:
VisualStudioTeamServices.ListBuildDefinitions (string account,
string project)

2420 | P a g e
 Visual Studio Team Services

Parameters:
Name Type Summary Required Related
Action
account string Choose a VSTS True ListAccounts
(Account account
name)
project string Choose a True ListProjects
(Project project within
name) the account

Returns:
Type:VstsList[BuildDefinition]
Description: A list of VSTS models

ListGitRepositories
Summary: List Git repositories
Description: Retrieves the list of Git repositories in a project

Syntax:
VisualStudioTeamServices.ListGitRepositories (string account,
string project)

Parameters:
Name Type Summary Required Related
Action
account string Choose a VSTS True ListAccounts
(Account account
name)

2421 | P a g e
 Visual Studio Team Services

project string Choose a True ListProjects

(Project project within
name) the account

Returns:
Type:VstsList[GitRepository]
Description: A list of VSTS models

ListGitRefs
Summary: List Git refs
Description: Retrieves the list of references (branches, tags, etc.) in a Git repo

Syntax:
VisualStudioTeamServices.ListGitRefs (string account, string
project, string repository)

Parameters:
Name Type Summary Required Related Action
account string Choose a VSTS True ListAccounts
(Account account
name)
project string Choose a True ListProjects
(Project project within
name) the account
repository string The repository True ListGitRepositories
(Repository) to watch for
changes

Returns:

2422 | P a g e
 Visual Studio Team Services

Type:VstsList[GitRef]
Description: A list of VSTS models

ListTeams
Summary: List the teams in a project
Description: Retrieves the list teams in a project

Syntax:
VisualStudioTeamServices.ListTeams (string account, string
project)

Parameters:
Name Type Summary Required Related
Action
account string Choose a VSTS True
(Account account
name)
project string Choose a project True
(Project within the
name) account

Returns:
Type:VstsList[Team]
Description: A list of VSTS models

ListTeamMembers
Summary: List the users in a team
Description: Retrieves the list of users in a team

2423 | P a g e
 Visual Studio Team Services

Syntax:
VisualStudioTeamServices.ListTeamMembers (string account, string
project, string team)

Parameters:
Name Type Summary Required Related
Action
account string Choose a VSTS True
(Account account
name)
project string Choose a project True
(Project within the
name) account
team string A team of users True
(Team
name)

Returns:
Type:VstsList[TeamMember]
Description: A list of VSTS models

QueueNewBuild
Summary: Queue a new build
Description: Create a build, based on an existing build definition, and add it to the
build queue.

Syntax:

2424 | P a g e
 Visual Studio Team Services

VisualStudioTeamServices.QueueNewBuild (string account, string

project, string buildDefId, [Optional]QueueBuildRequest
buildDetails)

Parameters:
Name Type Summary Required Related Action
account string Choose a True ListAccounts
(Account name) VSTS
account
project string Choose a True ListProjects
(Project name) project
within the
account
buildDefId string The True ListBuildDefinitions
(Build definition Id) identifier of
the build
definition
to use
buildDetails QueueBuildRequest A list of False
build
definitions

Returns:
Type:BuildResult
Description: The result of a build

CreateWorkItem
Summary: Create a new work item
Description: Create a work item, with provided attributes

2425 | P a g e
 Visual Studio Team Services

Syntax:
VisualStudioTeamServices.CreateWorkItem (string account, string
project, string type, CreateWorkItemRequest workItem)

Parameters:
Name Type Summary Required Related
Action
account string Choose a True ListAccounts
(Account name) VSTS
account
project string Choose a True ListProjects
(Project name) project
within the
account
type string Type of this True
(Type)Values: [Bug, Epic, work item
Feature, Issue, Task,
Test Case, User Story]
workItem CreateWorkItemRequest A work item True

Returns:
Type:WorkItemResponse
Description: A work item

UpdateWorkItem
Summary: Update a work item
Description: Update an existing work item by Id

2426 | P a g e
 Visual Studio Team Services

Syntax:
VisualStudioTeamServices.UpdateWorkItem (string account, string
id, UpdateWorkItemRequest workItem)

Parameters:
Name Type Summary Required Related
Action
account string Choose a True ListAccounts
(Account name) VSTS
account
id string Id of the True
(Work Item Id) work item
to update
workItem UpdateWorkItemRequest A work item True

Returns:
Type:WorkItemResponse
Description: A work item

GetColumnsSchema
Summary: Get the schema for dynamic custom fields
Description: Get the schema for dynamic custom fields

Syntax:
VisualStudioTeamServices.GetColumnsSchema (string numOfCustom)

Parameters:

2427 | P a g e
 Visual Studio Team Services

Name Type Summary Required Related

Action
numOfCustom string The number of True
(Number of custom fields to
fields) generate a
schema for

Returns:
Type:string

Triggers:
Trigger OnTfvcCheckIn
Summary: When code is checked in (TFVC)
Description: Triggers a flow when code is checked in to a Team Foundation Version
Control project.

Syntax:
VisualStudioTeamServices.OnTfvcCheckIn (string account, string
project, [Optional]string team, [Optional]string author)

Parameters:
Name Type Summary Required Related Action
account string Choose a VSTS True ListAccounts
(Account account
name)
project string Choose a True ListProjects
(Project project within
name) the account

2428 | P a g e
 Visual Studio Team Services

team string A team from False ListTeams

(Team to which to
lookup select an
author author
from)
author string The name of False ListTeamMembers
(Team the team
member) member who
authored the
check in

Returns:
Type:VstsList[TfvcChangeset]
Description: A list of VSTS models

Trigger OnGitPush
Summary: When code is pushed (Git)
Description: Triggers a flow when code is pushed to a Git repository.

Syntax:
VisualStudioTeamServices.OnGitPush (string account, string
project, string repository, [advanced][Optional]string refName)

Parameters:
Name Type Summary Required Related Action
account string Choose a VSTS True ListAccounts
(Account account
name)

2429 | P a g e
 Visual Studio Team Services

project string Choose a True ListProjects

(Project project within
name) the account
repository string The repository True ListGitRepositories
(Repository) to watch for
changes
refName string A Git ref - False ListGitRefs
(Ref name) such as a
branch or tag
- to watch for
changes

Returns:
Type:VstsList[GitPush]
Description: A list of VSTS models

Trigger OnBuildCompleted
Summary: When a build completes
Description: Triggers a flow when a build completes

Syntax:
VisualStudioTeamServices.OnBuildCompleted (string account,
string project, [Optional]string resultFilter,
[advanced][Optional]string definitions)

Parameters:
Name Type Summary Required Related
Action

2430 | P a g e
 Visual Studio Team Services

account string Choose a True ListAccounts

(Account name) VSTS account
project string Choose a True ListProjects
(Project name) project within
the account
resultFilter string Only trigger False
(Filter by on a specific
result)Values: [, build result
succeeded,
partiallySucceeded,
failed, canceled]
definitions string Only trigger False
(Filter by definition when these
Id) definitions
are used

Returns:
Type:VstsList[BuildResult]
Description: A list of VSTS models

Trigger OnWorkItemAssigned
Summary: When a work item is assigned
Description: Triggers a flow when a work item which matches provided criteria is
assigned to the given user

Syntax:
VisualStudioTeamServices.OnWorkItemAssigned (string account,
string project, [Optional]string team, string
wiql__System_AssignedTo, [advanced][Optional]string
wiql__System_WorkItemType, [advanced][Optional]string

2431 | P a g e
 Visual Studio Team Services

wiql__System_AreaPath, [advanced][Optional]string
wiql__System_IterationPath, [advanced][Optional]string
wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string
wiql__System_TeamProject, [advanced][Optional]string
wiql__Microsoft_VSTS_Common_CreatedBy)

Parameters:
Name Type Summa Requir Related Action
ry ed
account string Choose True ListAccounts
(Account a VSTS
name) account
project string Choose True ListProjects
(Project a
name) project
within
the
account
team string A team False ListTeams
(Team to from
lookup which
member to
from) select
an
assigne
e
wiql__System_AssignedTo string The True ListTeamMem
(Assigned name bers
To) of the
team

2432 | P a g e
 Visual Studio Team Services

membe
r who
currentl
y owns
the
work
item
wiql__System_WorkItemType string The False
(Type)Valu name
es: [Bug, of the
Epic, work
Feature, item
Issue, type
Task, Test
Case, User
Story]
wiql__System_AreaPath string Groups False
(Area work
Path) items
into
product
feature
or team
areas
wiql__System_IterationPath string Groups False
(Iteration work
Path) items
by
named

2433 | P a g e
 Visual Studio Team Services

sprints
or time
periods
wiql__Microsoft_VSTS_Common_ string A False
Priority (Priority) subjecti
ve
rating
of the
bug,
issue,
task, or
test
case as
it
relates
to the
busines
s
wiql__System_TeamProject string The False
(Team team
Project) project
to
which
this
work
item
belongs
wiql__Microsoft_VSTS_Common_ string The False
CreatedBy name

2434 | P a g e
 Visual Studio Team Services

(Created of the
By) team
membe
r who
created
the
work
item

Returns:
Type:VstsList[WorkItemResponse]
Description: A list of VSTS models

Trigger OnWorkItemUpdated
Summary: When a work item is updated
Description: Triggers a flow when a work item which matches provided criteria is
updated

Syntax:
VisualStudioTeamServices.OnWorkItemUpdated (string account,
string project, [Optional]string team, [Optional]string
wiql__System_AssignedTo, [Optional]string
wiql__System_WorkItemType, [advanced][Optional]string
wiql__System_AreaPath, [advanced][Optional]string
wiql__System_IterationPath, [advanced][Optional]string
wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string
wiql__System_TeamProject, [advanced][Optional]string
wiql__Microsoft_VSTS_Common_CreatedBy)

Parameters:

2435 | P a g e
 Visual Studio Team Services

Name Type Summa Requir Related Action

ry ed
account string Choose True ListAccounts
(Account a VSTS
name) account
project string Choose True ListProjects
(Project a
name) project
within
the
account
team string A team False ListTeams
(Team to from
lookup which
member to
from) select
an
assigne
e
wiql__System_AssignedTo string The False ListTeamMem
(Assigned name bers
To) of the
team
membe
r who
currentl
y owns
the

2436 | P a g e
 Visual Studio Team Services

work
item
wiql__System_WorkItemType string The False
(Type)Valu name
es: [Bug, of the
Epic, work
Feature, item
Issue, type
Task, Test
Case, User
Story]
wiql__System_AreaPath string Groups False
(Area work
Path) items
into
product
feature
or team
areas
wiql__System_IterationPath string Groups False
(Iteration work
Path) items
by
named
sprints
or time
periods
wiql__Microsoft_VSTS_Common_ string A False
Priority (Priority) subjecti

2437 | P a g e
 Visual Studio Team Services

ve
rating
of the
bug,
issue,
task, or
test
case as
it
relates
to the
busines
s
wiql__System_TeamProject string The False
(Team team
Project) project
to
which
this
work
item
belongs
wiql__Microsoft_VSTS_Common_ string The False
CreatedBy (Created name
By) of the
team
membe
r who
created

2438 | P a g e
 Visual Studio Team Services

the
work
item

Returns:
Type:VstsList[WorkItemResponse]
Description: A list of VSTS models

Trigger OnWorkItemCreated
Summary: When a work item is created
Description: Triggers a flow when a work item which matches provided criteria is
created

Syntax:
VisualStudioTeamServices.OnWorkItemCreated (string account,
string project, [Optional]string team, [Optional]string
wiql__System_AssignedTo, [Optional]string
wiql__System_WorkItemType, [advanced][Optional]string
wiql__System_AreaPath, [advanced][Optional]string
wiql__System_IterationPath, [advanced][Optional]string
wiql__Microsoft_VSTS_Common_Priority, [advanced][Optional]string
wiql__System_TeamProject, [advanced][Optional]string
wiql__Microsoft_VSTS_Common_CreatedBy)

Parameters:
Name Type Summa Requir Related Action
ry ed
account string Choose True ListAccounts
(Account a VSTS
name) account

2439 | P a g e
 Visual Studio Team Services

project string Choose True ListProjects

(Project a
name) project
within
the
account
team string A team False ListTeams
(Team to from
lookup which
member to
from) select
an
assigne
e
wiql__System_AssignedTo string The False ListTeamMem
(Assigned name bers
To) of the
team
membe
r who
currentl
y owns
the
work
item
wiql__System_WorkItemType string The False
(Type)Valu name
es: [Bug, of the
Epic, work

2440 | P a g e
 Visual Studio Team Services

Feature, item
Issue, type
Task, Test
Case, User
Story]
wiql__System_AreaPath string Groups False
(Area work
Path) items
into
product
feature
or team
areas
wiql__System_IterationPath string Groups False
(Iteration work
Path) items
by
named
sprints
or time
periods
wiql__Microsoft_VSTS_Common_ string A False
Priority (Priority) subjecti
ve
rating
of the
bug,
issue,
task, or

2441 | P a g e
 Visual Studio Team Services

test
case as
it
relates
to the
busines
s
wiql__System_TeamProject string The False
(Team team
Project) project
to
which
this
work
item
belongs
wiql__Microsoft_VSTS_Common_ string The False
CreatedBy (Created name
By) of the
team
membe
r who
created
the
work
item

Returns:
Type:VstsList[WorkItemResponse]

2442 | P a g e
 Visual Studio Team Services

Description: A list of VSTS models

2443 | P a g e
 Visual Studio Team Services

Account
Summary:
Description: A list of VSTS models

Properties:
Name Type Summary
accountId string Account Id
Account Id
accountUri string Account URI
Account URI
accountName string Account name
Account name
organizationName string Organization name
Organization name
accountType string Account type
Account type
accountOwner string Account owner
Account owner

2444 | P a g e
 Visual Studio Team Services

BuildDefinition
Summary:
Description: A VSTS Build definition

Properties:
Name Type Summary
type string Build Definition Type
Type
revision integer(int32) Build Definition Revision
Revision
id integer(int32) Build Definition Id
Id
name string Build Definition Name
Name
_links Links

2445 | P a g e
 Visual Studio Team Services

BuildRequestUser
Summary:
Description: The user for whom the build was requested

Properties:
Name Type Summary
uniqueName string The unique name of the
Requested for user the build was
requested for

2446 | P a g e
 Visual Studio Team Services

BuildResult
Summary:
Description: The result of a build

Properties:
Name Type Summary
_links Links

id integer(int32) The build's unique

Build Id identifier
buildNumber string The build number
Build number
status string The build's status
Status
result string The build result
Result
queueTime string The time the build was
Queue time queued
startTime string The time the build
Start time started
finishTime string The time the build
Finish time finished
definition BuildResultDefinition The build definition with
whicn the build was
started
sourceBranch string The source control
Source branch branch the build used
sourceVersion string The source control
Source version version the build used

2447 | P a g e
 Visual Studio Team Services

priority string The priority of the build

Priority
reason string The reason for the build
Reason
requestedFor BuildRequestUser The user for whom the
build was requested
parameters string Parameters passed to the
Parameters build, if any.

2448 | P a g e
 Visual Studio Team Services

BuildResultDefinition
Summary:
Description: The build definition with whicn the build was started

Properties:
Name Type Summary
id integer(int32) The identifier of the build
Build definition Id definiton
name string The name of the build
Build definition name definition

2449 | P a g e
 Visual Studio Team Services

ChangesetAuthor
Summary:
Description: Info regarding who created the push

Properties:
Name Type Summary
displayName string The name of the user who
Author name created the push
uniqueName string The unique name of the
Pusher unique name user who created the push

2450 | P a g e
 Visual Studio Team Services

ChangesetCheckedInBy
Summary:
Description: Info regarding who created the push

Properties:
Name Type Summary
displayName string The name of the user who
Checked in by name created the push
uniqueName string The unique name of the
Checked in by unique user who created the
name push

2451 | P a g e
 Visual Studio Team Services

CreateWorkItemRequest
Summary:
Description: A work item

Properties:
Name Type Summary
title string The title of the work item
Title
description string Description of the work
Description item
priority integer(int32) Priority of the work item
Priority
iteration string Iteration path of the work
Iteration path item
area string Area path of the work
Area path item
linkUrl string URL of the work item to
Link URL link with this one
linkType string Link Type Values:
Link type [Dependancy-forward,
Dependancy-reverse,
Hierarchy-forward,
Hierarchy-reverse,
Related]
linkComment string Comment for the link
Link comment

2452 | P a g e
 Visual Studio Team Services

GitPush
Summary:
Description: A Git push

Properties:
Name Type Summary
repository GitRepository A Git repository

pushedBy GitPushUser Info regarding who

created the push
pushId integer(int32) Identifies this push
Push Id
date string When this push occurred
Date

2453 | P a g e
 Visual Studio Team Services

GitPushUser
Summary:
Description: Info regarding who created the push

Properties:
Name Type Summary
id string Identifies who created the
Pusher Id push
displayName string The name of the user who
Pusher name created the push
uniqueName string The unique name of the
Pusher unique name user who created the push

2454 | P a g e
 Visual Studio Team Services

GitRef
Summary:
Description: A Git repository

Properties:
Name Type Summary
objectId string Repository unique Id
Ref Id
name string The name of this
Ref name repository

2455 | P a g e
 Visual Studio Team Services

GitRepository
Summary:
Description: A Git repository

Properties:
Name Type Summary
id string Repository unique Id
Repository Id
name string The name of this
Repository name repository
remoteUrl string The URL via which git can
Repository remote URL sync with this repository

2456 | P a g e
 Visual Studio Team Services

Links
Summary:
Description:

Properties:
Name Type Summary
web WebLinks Links to human-readable
web pages

2457 | P a g e
 Visual Studio Team Services

Project
Summary:
Description: A VSTS Project

Properties:
Name Type Summary
id string The project's unique
Project Id identifier
name string The project's name
Project name
url string The project's API URL.
Project URL

2458 | P a g e
 Visual Studio Team Services

QueueBuildRequest
Summary:
Description: A list of build definitions

Properties:
Name Type Summary
sourceBranch string The build's source branch
Source branch
parameters string A JSON dictionary of
Parameters optional build parameters.

2459 | P a g e
 Visual Studio Team Services

Team
Summary:
Description: A project team

Properties:
Name Type Summary
id string Team Id
Team Id
name string Team name
Team name
url string Account URI
Team URI
description string Team description
Team description
identityUrl string Identities URI
Team URI

2460 | P a g e
 Visual Studio Team Services

TeamMember
Summary:
Description: A projecct team

Properties:
Name Type Summary
id string Team member Id
Team member Id
displayName string Display name
Display name
uniqueName string Username
Unique name
url string Member URI
Member URI
imageUrl string Image URI
Image URI

2461 | P a g e
 Visual Studio Team Services

TfvcChangeset
Summary:
Description: A TFVC Changeset

Properties:
Name Type Summary
changesetId integer(int32) Identifies this changeset
Changeset Id
author ChangesetAuthor Info regarding who
created the push
checkedInBy ChangesetCheckedInBy Info regarding who
created the push
createdDate string When this changeset was
Created date created
comment string The comment describing
Comment the changeset

2462 | P a g e
 Visual Studio Team Services

UpdateWorkItemRequest
Summary:
Description: A work item

Properties:
Name Type Summary
title string The title of the work item
Title
description string Description of the work
Description item
priority integer(int32) Priority of the work item
Priority
iteration string Iteration path of the work
Iteration path item
area string Area path of the work
Area path item
linkUrl string URL of the work item to
Link URL link with this one
linkType string Link Type Values:
Link type [Dependancy-forward,
Dependancy-reverse,
Hierarchy-forward,
Hierarchy-reverse,
Related]
linkComment string Comment for the link
Link comment

2463 | P a g e
 Visual Studio Team Services

VstsList[Account]
Summary:
Description: A list of VSTS models

Properties:
Name Type Summary
value array of (Account) The VSTS Models
Value

2464 | P a g e
 Visual Studio Team Services

VstsList[BuildDefinition]
Summary:
Description: A list of VSTS models

Properties:
Name Type Summary
value array of (BuildDefinition) The VSTS Models
Value

2465 | P a g e
 Visual Studio Team Services

VstsList[BuildResult]
Summary:
Description: A list of VSTS models

Properties:
Name Type Summary
value array of (BuildResult) The VSTS Models
Value

2466 | P a g e
 Visual Studio Team Services

VstsList[GitPush]
Summary:
Description: A list of VSTS models

Properties:
Name Type Summary
value array of (GitPush) The VSTS Models
Value

2467 | P a g e
 Visual Studio Team Services

VstsList[GitRef]
Summary:
Description: A list of VSTS models

Properties:
Name Type Summary
value array of (GitRef) The VSTS Models
Value

2468 | P a g e
 Visual Studio Team Services

VstsList[GitRepository]
Summary:
Description: A list of VSTS models

Properties:
Name Type Summary
value array of (GitRepository) The VSTS Models
Value

2469 | P a g e
 Visual Studio Team Services

VstsList[Project]
Summary:
Description: A list of VSTS models

Properties:
Name Type Summary
value array of (Project) The VSTS Models
Value

2470 | P a g e
 Visual Studio Team Services

VstsList[TeamMember]
Summary:
Description: A list of VSTS models

Properties:
Name Type Summary
value array of (TeamMember) The VSTS Models
Value

2471 | P a g e
 Visual Studio Team Services

VstsList[Team]
Summary:
Description: A list of VSTS models

Properties:
Name Type Summary
value array of (Team) The VSTS Models
Value

2472 | P a g e
 Visual Studio Team Services

VstsList[TfvcChangeset]
Summary:
Description: A list of VSTS models

Properties:
Name Type Summary
value array of (TfvcChangeset) The VSTS Models
Value

2473 | P a g e
 Visual Studio Team Services

VstsList[WorkItemResponse]
Summary:
Description: A list of VSTS models

Properties:
Name Type Summary
value array of The VSTS Models
(WorkItemResponse)
Value

2474 | P a g e
 Visual Studio Team Services

WebLinks
Summary:
Description: Links to human-readable web pages

Properties:
Name Type Summary
href string The web URL of build
HTML link details

2475 | P a g e
 Visual Studio Team Services

WorkItemFields
Summary:
Description: Fields of the work item

Properties:
Name Type Summary
System_AreaPath string Area Path
Area path
System_TeamProject string Team Project
Team project
System_IterationPath string Iteration Path
Iteration path
System_WorkItemType string Work Item Type
Work item type
System_State string State
State
System_Reason string Reason
Reason
System_CreatedDate string Created Date
Created date
System_CreatedBy string Created By
Created by
System_ChangedDate string Changed Date
Changed date
System_ChangedBy string Changed By
Changed By
System_Title string Title
Title

2476 | P a g e
 Visual Studio Team Services

Microsoft_VSTS_Common_StateChangeDate string State Changed

State changed Date
date
Microsoft_VSTS_Common_Priority integer Priority
Priority
Microsoft_VSTS_Common_Severity string Severity
Severity
Microsoft_VSTS_Common_ValueArea string Value Area
Value area
System_Description string Description
Description

2477 | P a g e
 Visual Studio Team Services

WorkItemResponse
Summary:
Description: A work item

Properties:
Name Type Summary
id integer The Id
Id
rev integer The revision count
Revision count
url string The URL
URL
fields WorkItemFields Fields of the work item

2478 | P a g e
 WebMerge

WebMerge
Automatically populate templates with data from your favorite cloud apps.
Never copy & paste again!

Status: Preview Tier: Standard Version: 1.0.0

Actions:
Name Summary
GetDocuments ([Optional]string Get Documents
search, [Optional]string folder)
GetDocumentFields (number id, Get Document Fields
[internal]string format)
MergeDocument (number id, Merge Document
MergeDocumentParameterFields
fields, [internal]string download)
GetRoutes ([Optional]string Get Data Routes
search, [Optional]string folder)
GetRouteFields (number id, Get Data Route Fields
[internal]string format)
MergeRoute (number id, Merge Data Route
MergeRouteParameterFields
fields, [internal]string download,
[internal]string list_files)

Triggers:
Name Summary

2479 | P a g e
 WebMerge

Objects:
Name Summary
Document
Field
File
MergedDocument
MergeDocumentParameterFields
MergedRoute
MergeRouteParameterFields
Route

Actions:
GetDocuments
Summary: Get Documents
Description: This endpoint returns information about the documents in a user's
account. The response includes the display name and other details about each
documents.

Syntax:
WebMerge.GetDocuments ([Optional]string search, [Optional]string
folder)

Parameters:
Name Type Summary Required Related
Action
search string Search False
(Search documents for
string) this string.

2480 | P a g e
 WebMerge

folder string Return list of False

(Folder documents in
name) this folder.

Returns:
Type:array of (Document)

GetDocumentFields
Summary: Get Document Fields
Description: This endpoint returns the fields inside the selected document.

Syntax:
WebMerge.GetDocumentFields (number id, [internal]string format)

Parameters:
Name Type Summary Required Related
Action
id number The Document ID True
(Document to query.
ID)
format string True

Returns:
Type:array of (Field)

MergeDocument
Summary: Merge Document
Description: This endpoint merges data into a document.

2481 | P a g e
 WebMerge

Syntax:
WebMerge.MergeDocument (number id, MergeDocumentParameterFields
fields, [internal]string download)

Parameters:
Name Type Summary Require Related
d Action
id number The True GetDocument
(Pick Document) Documen s
t ID to
merge.
fields MergeDocumentParameterField An object True
s that
represent
s the
posting of
fields.
downloa string True
d

Returns:
Type:MergedDocument

GetRoutes
Summary: Get Data Routes
Description: This endpoint returns information about the data routes in a user's
account. The response includes the display name and other details about each data
route.

2482 | P a g e
 WebMerge

Syntax:
WebMerge.GetRoutes ([Optional]string search, [Optional]string
folder)

Parameters:
Name Type Summary Required Related
Action
search string Search data False
(Search routes for this
string) string.
folder string Return list of False
(Folder data routes in
name) this folder.

Returns:
Type:array of (Route)

GetRouteFields
Summary: Get Data Route Fields
Description: This endpoint returns the fields inside the selected data route.

Syntax:
WebMerge.GetRouteFields (number id, [internal]string format)

Parameters:
Name Type Summary Required Related
Action
id number Data Route ID True

2483 | P a g e
 WebMerge

(Date
Route ID)
format string True

Returns:
Type:array of (Field)

MergeRoute
Summary: Merge Data Route
Description: This endpoint merges data into a data route.

Syntax:
WebMerge.MergeRoute (number id, MergeRouteParameterFields
fields, [internal]string download, [internal]string list_files)

Parameters:
Name Type Summary Required Related
Action
id number The Data True GetRoutes
(Pick Data Route) Route ID.
fields MergeRouteParameterFields An object True
that
represents
the posting
of fields.
download string True

list_files string True

2484 | P a g e
 WebMerge

Returns:
Type:MergedRoute

2485 | P a g e
 WebMerge

Document
Summary:
Description:

Properties:
Name Type Summary
id number Unique identifier
Document ID representing the specific
document.
key string Unique key used to
Document Key authenticate a document
during merge.
type string The type of document
Type (template type).
name string The name of the
Name document.
output_name string The name of the merged
Output Name document.
size_width string The page width of the
Width PDF.
size_height string The page height of the
Height PDF.
active number A 1/0 boolean indicating if
Active the document is active.
url string The Merge URL for the
Merge URL document.
fields array of (Field) The fields inside the
Fields document.

2486 | P a g e
 WebMerge

Field
Summary:
Description:

Properties:
Name Type Summary
key string Unique identifier for the
Key merge field.
name string The name of the merge
Name field.

2487 | P a g e
 WebMerge

File
Summary:
Description:

Properties:
Name Type Summary
name string The name of the file.
File Name
url string The temporary URL to the
Merged Document URL merged document.
document_id string The ID of the merged
Merged Document ID document.

2488 | P a g e
 WebMerge

MergedDocument
Summary:
Description:

Properties:
Name Type Summary
success number Will return 1 if the request
Success Response was a success.
name string The name of the merged
File Name file.
url string The temporary URL to the
Merged Document URL merged document.

2489 | P a g e
 WebMerge

MergeDocumentParameterFields
Summary:
Description: An object that represents the posting of fields.

Properties:
Name Type Summary

2490 | P a g e
 WebMerge

MergedRoute
Summary:
Description:

Properties:
Name Type Summary
success number Will return 1 if the request
Success Response was a success.
files array of (File) The files from the data
Files route.

2491 | P a g e
 WebMerge

MergeRouteParameterFields
Summary:
Description: An object that represents the posting of fields.

Properties:
Name Type Summary

2492 | P a g e
 WebMerge

Route
Summary:
Description:

Properties:
Name Type Summary
id number Unique identifier for the
Route ID data route.
key string Unique key used to
Route Key authenticate a data route
during merge.
name string The name of the data
Name route.
url string The Merge URL for the
Merge URL data route.
fields array of (Field) The fields inside the data
Fields route.

2493 | P a g e
 WordPress

WordPress
WordPress is web software you can use to create a beautiful website, blog, or
app.

Status: Preview Tier: Standard Version: 1.0.20

Actions:
Name Summary
ListAllMyPosts List posts
([internal][Optional]string
fields)
SiteStatsChartData (string Get site stats chart data
siteId, [Optional]string unit,
[internal][Optional]integer
http_envelope,
[advanced][Optional]string
quantity, [Optional]string
date)
ListInsightsStats (string siteId) Get site related list of metrics and insights
SiteStats (string siteId, Get site statistics
[internal][Optional]string
fields)
SiteTopPosts (string siteId, Get site top posts and pages by views
[advanced][Optional]string
num, [Optional]string period,
[advanced][Optional]string
max)

2494 | P a g e
 WordPress

ListPosts (string siteId, List posts from a site

[advanced][Optional]string
number,
[advanced][Optional]string
after,
[advanced][Optional]string
before, [Optional]string
status,
[internal][Optional]string
fields)
GetPost (string siteId, string Get post
postId)
CreatePost (string siteId, Create post
CreatePostModel post)
ListSites List sites
([internal][Optional]string
fields)

Triggers:
Name Summary
OnTriggerNewPost () When a post is created

Objects:
Name Summary
CreatePostModel
ListAllMyPostsResponseItem
ListPostsResponse
PostModel

2495 | P a g e
 WordPress

PostResponse
Site
SiteInsightsModel
SiteList
SiteStatsChartDataResponseItem
SiteStatsModel
SiteTopPostsResponseItem

Actions:
ListAllMyPosts
Summary: List posts
Description: List all posts from current user's sites

Syntax:
WordPress.ListAllMyPosts ([internal][Optional]string fields)

Parameters:
Name Type Summary Required Related
Action
fields string Comma- False
(Fields) separated list of
fields to include.

Returns:
Type:array of (ListAllMyPostsResponseItem)

SiteStatsChartData
Summary: Get site stats chart data
Description: Get site stats chart data
2496 | P a g e
 WordPress

Syntax:
WordPress.SiteStatsChartData (string siteId, [Optional]string
unit, [internal][Optional]integer http_envelope,
[advanced][Optional]string quantity, [Optional]string date)

Parameters:
Name Type Summary Required Related
Action
siteId string The site's id or True ListSites
(Site Id) domain
unit string year, week, False
(Unit) month or day
http_envelope integer http_envelope False
(Http
Envelope)
quantity string Number of units False
(Quantity) to return
date string Date False
(Date)

Returns:
Type:array of (SiteStatsChartDataResponseItem)

ListInsightsStats
Summary: Get site related list of metrics and insights
Description: Get site related list of metrics and insights

Syntax:

2497 | P a g e
 WordPress

WordPress.ListInsightsStats (string siteId)

Parameters:
Name Type Summary Required Related
Action
siteId string The site's id or True ListSites
(Site Id) domain

Returns:
Type:SiteInsightsModel

SiteStats
Summary: Get site statistics
Description: Get statistics for a specified site

Syntax:
WordPress.SiteStats (string siteId, [internal][Optional]string
fields)

Parameters:
Name Type Summary Required Related
Action
siteId string The site's id or True ListSites
(Site Id) domain
fields string Fields to include False
(Fields)

Returns:
Type:SiteStatsModel

2498 | P a g e
 WordPress

SiteTopPosts
Summary: Get site top posts and pages by views
Description: View a site's top posts and pages by views

Syntax:
WordPress.SiteTopPosts (string siteId,
[advanced][Optional]string num, [Optional]string period,
[advanced][Optional]string max)

Parameters:
Name Type Summary Required Related
Action
siteId string The site's id or True ListSites
(Site Id) domain
num string Number of False
(Number) periods to
include in the
results Default is
1.
period string Time filter- day, False
(Period) week, month or
year.
max string The maximum False
(Max) number of
results to return
Default is 10.

Returns:

2499 | P a g e
 WordPress

Type:array of (SiteTopPostsResponseItem)

ListPosts
Summary: List posts from a site
Description: List posts from a site

Syntax:
WordPress.ListPosts (string siteId, [advanced][Optional]string
number, [advanced][Optional]string after,
[advanced][Optional]string before, [Optional]string status,
[internal][Optional]string fields)

Parameters:
Name Type Summary Required Related
Action
siteId string The site's id or True ListSites
(Site Id) domain
number string The number of False
(Number) posts to
return.Limit 100,
Default 10
after string Return posts False
(After) dated after the
specified
datetime. (iso
8601 datetime)
before string Return posts False
(Before) dated before the
specified

2500 | P a g e
 WordPress

datetime. (iso
8601 datetime)
status string Comma- False
(Status) separated list of
statuses for
which to query,
including any of:
publish, private,
draft, pending,
future, and
trash, or simply
any. Defaults to
publish
fields string Comma- False
(Fields) separated list of
fields to include.

Returns:
Type:array of (ListAllMyPostsResponseItem)

GetPost
Summary: Get post
Description: Get post

Syntax:
WordPress.GetPost (string siteId, string postId)

Parameters:

2501 | P a g e
 WordPress

Name Type Summary Required Related

Action
siteId string The site's id or True ListSites
(Site Id) domain
postId string The post Id. True
(Post Id)

Returns:
Type:PostModel

CreatePost
Summary: Create post
Description: Create post

Syntax:
WordPress.CreatePost (string siteId, CreatePostModel post)

Parameters:
Name Type Summary Required Related
Action
siteId string The site's id or True ListSites
(Site ID) domain.
post CreatePostModel A Blogger post True
object for new
post requests

Returns:
Type:PostModel

2502 | P a g e
 WordPress

ListSites
Summary: List sites
Description: List sites

Syntax:
WordPress.ListSites ([internal][Optional]string fields)

Parameters:
Name Type Summary Required Related
Action
fields string Comma- False
(Fields) separated list of
fields to include.

Returns:
Type:SiteList
Description: A list of sites

Triggers:
Trigger OnTriggerNewPost
Summary: When a post is created
Description: Triggers a new flow when there is a new post on the logged in user's
timeline

Syntax:
WordPress.OnTriggerNewPost ()

Returns:
Type:ListPostsResponse

2503 | P a g e
 WordPress

2504 | P a g e
 WordPress

CreatePostModel
Summary:
Description: A Blogger post object for new post requests

Properties:
Name Type Summary
title string The title of the post
Title
content string The content of the post in
Content html
status string The status of the post
Status Values: [draft, publish,
private, pending, future,
auto-draft]
tags string The tags for post
Tags

2505 | P a g e
 WordPress

ListAllMyPostsResponseItem
Summary:
Description:

Properties:
Name Type Summary
ID integer
ID
comment_count integer
Comment Count
site_ID integer
Site ID
date string
Date
modified string
Modified
title string
Title
URL string
URL
slug string
Slug
guid string
Guid
type string
Type
like_count integer
Like Count

2506 | P a g e
 WordPress

ListPostsResponse
Summary:
Description:

Properties:
Name Type Summary
posts array of (PostResponse) Posts
Posts

2507 | P a g e
 WordPress

PostModel
Summary:
Description:

Properties:
Name Type Summary
ID integer
ID
site_ID integer
Site ID
date string
Date
modified string
Modified
title string
Title
URL string
URL
short_URL string
Short URL
content string
Content
excerpt string
Excerpt
slug string
Slug
guid string
Guid
status string

2508 | P a g e
 WordPress

Status
sticky boolean
Sticky
password string
Password
parent boolean
Parent
type string
Type
likes_enabled boolean
Likes Enabled
sharing_enabled boolean
Sharing Enabled
like_count integer
Like Count
i_like boolean
I Like
is_reblogged boolean
Is Rebloggled
is_following boolean
Is Following
global_ID string
Global ID
featured_image string
Featured Image
post_thumbnail string
Post Thumbnail
format string
Format

2509 | P a g e
 WordPress

geo boolean
Geo

2510 | P a g e
 WordPress

PostResponse
Summary:
Description:

Properties:
Name Type Summary
ID integer
ID
comment_count integer
Comment Count
site_ID integer
Site ID
date string
Date
modified string
Modified
title string
Title
URL string
URL
slug string
Slug
guid string
Guid
type string
Type
like_count integer
Like Count

2511 | P a g e
 WordPress

Site
Summary:
Description: List of site items

Properties:
Name Type Summary
ID integer Site ID
Site ID
name string Site Name
Site Name
description string Site Description
Site Description
URL string Site URL
Site Url
is_multisite boolean Whether the site is a
Is Multisite Multisite site or not.
Always true for WP.com
sites.
post_count integer The number of posts the
Post Count site has
subscribers_count integer The number of
Subscribers Count subscribers the site has
lang string Language
Language
visible boolean Site visibility
Visible
is_private boolean Is site private
Is Private
single_user_site boolean Is single user site

2512 | P a g e
 WordPress

Is Single User Site

is_vip boolean Is VIP
Is VIP
is_following boolean Is Following
Is Following

2513 | P a g e
 WordPress

SiteInsightsModel
Summary:
Description:

Properties:
Name Type Summary
highest_hour integer
Highest Hour
highest_hour_percent number
Highest Hour Percent
highest_day_of_week integer
Highest Day Of Week
highest_day_percent number
Highest Day Percent

2514 | P a g e
 WordPress

SiteList
Summary:
Description: A list of sites

Properties:
Name Type Summary
sites array of (Site) List of sites
Sites

2515 | P a g e
 WordPress

SiteStatsChartDataResponseItem
Summary:
Description:

Properties:
Name Type Summary
period string
Period
views integer
Views
visitors integer
Visitors
likes integer
Likes
reblogs integer
Reblogs
comments integer
Comments
posts integer
Posts

2516 | P a g e
 WordPress

SiteStatsModel
Summary:
Description:

Properties:
Name Type Summary
visitors_today integer
Visitors Today
visitors_yesterday integer
Visitors_Yesterday
visitors integer
Visitors
views_today integer
View Today
views_yesterday integer
Views Yesterday
views_best_day string
Views Best Day
views_best_day_total integer
Views Best Day Total
views integer
Views
comments integer
Comments
posts integer
Posts
followers_blog integer
Followers Blog
followers_comments integer

2517 | P a g e
 WordPress

Followers Comments
comments_per_month integer
Comments Per Month
comments_most_active_recent_day string
Comments Most Active
Recent Day
comments_most_active_time string
Comments Most Active
Time
comments_spam integer
Comments Spam
categories integer
Categories
tags integer
Tags
shares integer
Shares
shares_twitter integer
Shares Twitter
shares_facebook integer
Shares Facebook
shares_press-this integer
Shares Press This

2518 | P a g e
 WordPress

SiteTopPostsResponseItem
Summary:
Description:

Properties:
Name Type Summary
id integer
ID
href string
Link
date string
Date
title string
Title
type string
Type
views integer
Views
video_play boolean
Video Play

2519 | P a g e
 Wunderlist

Wunderlist
Wunderlist provide a todo list and task manager to help people get their stuff
done. Whether you’re sharing a grocery list with a loved one, working on a
project, or planning a vacation, Wunderlist makes it easy to capture, share,
and complete your to-dos. Wunderlist instantly syncs between your phone, tablet and
computer, so you can access all your tasks from anywhere.

Status: Production Tier: Standard Version: 1.0

Actions:
Name Summary
RetrieveLists () Get lists
CreateList (NewList post) Create a list
ListTasks (integer list_id, Get tasks
[Optional]boolean completed)
CreateTask (NewTask post) Create a task
ListSubTasks (integer list_id, Get subtasks
[Optional]integer task_id,
[Optional]boolean completed)
CreateSubTask (NewSubtask Create a subtask
post)
ListNotes (integer list_id, Get notes
[Optional]integer task_id)
CreateNote (NewNote post) Create a note
ListComments (integer list_id, Get task comments
[Optional]integer task_id)
CreateComment Add a comment to a task
(NewComment post)

2520 | P a g e
 Wunderlist

RetrieveReminders (integer Get reminders

list_id, [Optional]integer
task_id)
CreateReminder Set a reminder
(NewReminder post)
RetrieveFiles (integer list_id, Get files
[Optional]integer task_id)
GetList (string id) Get list
DeleteList (integer id, integer Delete list
revision)
UpdateList (integer id, Update a list
UpdateList post)
GetTask (integer list_id, Get task
integer id)
UpdateTask (integer list_id, Update a task
integer id, UpdateTask post)
DeleteTask (integer list_id, Delete task
integer id, integer revision)
GetSubTask (string id) Get subtask
UpdateSubTask (integer id, Update a subtask
UpdateSubtask post)
DeleteSubTask (integer id, Delete a subtask
integer revision)
GetNote (string id) Get a note
UpdateNote (integer id, Update a note
UpdateNote post)
DeleteNote (integer id, Delete a note
integer revision)
GetComment (string id) Get task comment

2521 | P a g e
 Wunderlist

UpdateReminder (integer id, Update a reminder

UpdateReminder post)
DeleteReminder (integer id, Delete a reminder
integer revision)

Triggers:
Name Summary
TriggerTaskDue (integer When a task is due
list_id)
TriggerTaskNew (integer When a new task is created
list_id)
TriggerReminder (integer When a reminder occurs
list_id, [Optional]integer
task_id)

Objects:
Name Summary
Comment
CreatedList
CreatedReminder
File
List
NewComment
NewList
NewNote
NewReminder
NewSubtask
NewTask

2522 | P a g e
 Wunderlist

Note
Reminder
Subtask
Task
UpdateList
UpdateNote
UpdateReminder
UpdateSubtask
UpdateTask

Actions:
RetrieveLists
Summary: Get lists
Description: Retrieve the lists associated with your account.

Syntax:
Wunderlist.RetrieveLists ()

Returns:
Type:array of (List)

CreateList
Summary: Create a list
Description: Create a list.

Syntax:
Wunderlist.CreateList (NewList post)

2523 | P a g e
 Wunderlist

Parameters:
Name Type Summary Required Related
Action
post NewList True

Returns:
Type:CreatedList
Description: Model for create list response

ListTasks
Summary: Get tasks
Description: Retrieve tasks from a specific list.

Syntax:
Wunderlist.ListTasks (integer list_id, [Optional]boolean
completed)

Parameters:
Name Type Summary Required Related
Action
list_id integer List ID True RetrieveLists
(List ID)
completed boolean Completed False
(Show
completed
tasks.)

Returns:

2524 | P a g e
 Wunderlist

Type:array of (Task)

CreateTask
Summary: Create a task
Description: Create a task

Syntax:
Wunderlist.CreateTask (NewTask post)

Parameters:
Name Type Summary Required Related
Action
post NewTask True

Returns:
Type:Task
Description: Model for Task

ListSubTasks
Summary: Get subtasks
Description: Retrieve subtasks from a specific list or from a specific task.

Syntax:
Wunderlist.ListSubTasks (integer list_id, [Optional]integer
task_id, [Optional]boolean completed)

Parameters:

2525 | P a g e
 Wunderlist

Name Type Summary Required Related

Action
list_id integer List ID True RetrieveLists
(List ID)
task_id integer Task ID False ListTasks
(Task ID)
completed boolean Completed False
(Show
completed
tasks.)

Returns:
Type:array of (Subtask)

CreateSubTask
Summary: Create a subtask
Description: Create a subtask within a specific task

Syntax:
Wunderlist.CreateSubTask (NewSubtask post)

Parameters:
Name Type Summary Required Related
Action
post NewSubtask True

Returns:
Type:Subtask

2526 | P a g e
 Wunderlist

Description: Model for Subtask

ListNotes
Summary: Get notes
Description: Retrieve notes for a specific list or a specific task.

Syntax:
Wunderlist.ListNotes (integer list_id, [Optional]integer
task_id)

Parameters:
Name Type Summary Required Related
Action
list_id integer List ID True RetrieveLists
(List ID)
task_id integer Task ID False ListTasks
(Task ID)

Returns:
Type:array of (Note)

CreateNote
Summary: Create a note
Description: Add a note to a specific task

Syntax:
Wunderlist.CreateNote (NewNote post)

Parameters:

2527 | P a g e
 Wunderlist

Name Type Summary Required Related

Action
post NewNote True

Returns:
Type:Note
Description: Model for Note

ListComments
Summary: Get task comments
Description: Retrieve task comments for a specific list or a specific task.

Syntax:
Wunderlist.ListComments (integer list_id, [Optional]integer
task_id)

Parameters:
Name Type Summary Required Related
Action
list_id integer List ID True RetrieveLists
(List ID)
task_id integer Task ID False ListTasks
(Task ID)

Returns:
Type:array of (Comment)

2528 | P a g e
 Wunderlist

CreateComment
Summary: Add a comment to a task
Description: Add a comment to a specific task

Syntax:
Wunderlist.CreateComment (NewComment post)

Parameters:
Name Type Summary Required Related
Action
post NewComment True

Returns:
Type:Comment
Description: Model for Task Comment

RetrieveReminders
Summary: Get reminders
Description: Retrieve reminders for a specific list or a specific task.

Syntax:
Wunderlist.RetrieveReminders (integer list_id, [Optional]integer
task_id)

Parameters:
Name Type Summary Required Related
Action
list_id integer List ID True RetrieveLists

2529 | P a g e
 Wunderlist

(List ID)
task_id integer Task ID False ListTasks
(Task ID)

Returns:
Type:array of (Reminder)

CreateReminder
Summary: Set a reminder
Description: Set a reminder.

Syntax:
Wunderlist.CreateReminder (NewReminder post)

Parameters:
Name Type Summary Required Related
Action
post NewReminder True

Returns:
Type:CreatedReminder
Description: Model for create reminder response

RetrieveFiles
Summary: Get files
Description: Retrieve files for a specific list or a specific task.

Syntax:

2530 | P a g e
 Wunderlist

Wunderlist.RetrieveFiles (integer list_id, [Optional]integer

task_id)

Parameters:
Name Type Summary Required Related
Action
list_id integer List ID True RetrieveLists
(List ID)
task_id integer Task ID False ListTasks
(Task ID)

Returns:
Type:array of (File)

GetList
Summary: Get list
Description: Retrieves a specific list

Syntax:
Wunderlist.GetList (string id)

Parameters:
Name Type Summary Required Related
Action
id string List ID True RetrieveLists
(List ID)

Returns:
Type:List

2531 | P a g e
 Wunderlist

Description: Model for List

DeleteList
Summary: Delete list
Description: Deletes a list

Syntax:
Wunderlist.DeleteList (integer id, integer revision)

Parameters:
Name Type Summary Required Related
Action
id integer List ID True
(List ID)
revision integer Revision True
(Revision)

Returns:

UpdateList
Summary: Update a list
Description: Update a specific list

Syntax:
Wunderlist.UpdateList (integer id, UpdateList post)

Parameters:

2532 | P a g e
 Wunderlist

Name Type Summary Required Related

Action
id integer List ID True
(List ID)
post UpdateList True

Returns:
Type:List
Description: Model for List

GetTask
Summary: Get task
Description: Retrieves a specific task

Syntax:
Wunderlist.GetTask (integer list_id, integer id)

Parameters:
Name Type Summary Required Related
Action
list_id integer List ID True RetrieveLists
(List ID)
id integer Task ID True ListTasks
(Task ID)

Returns:
Type:Task
Description: Model for Task

2533 | P a g e
 Wunderlist

UpdateTask
Summary: Update a task
Description: Updates a specific task

Syntax:
Wunderlist.UpdateTask (integer list_id, integer id, UpdateTask
post)

Parameters:
Name Type Summary Required Related
Action
list_id integer List ID True RetrieveLists
(List ID)
id integer Task ID True ListTasks
(Task ID)
post UpdateTask True

Returns:
Type:Task
Description: Model for Task

DeleteTask
Summary: Delete task
Description: Deletes a specific task

Syntax:

2534 | P a g e
 Wunderlist

Wunderlist.DeleteTask (integer list_id, integer id, integer

revision)

Parameters:
Name Type Summary Required Related
Action
list_id integer List ID True RetrieveLists
(List ID)
id integer Task ID True ListTasks
(Task ID)
revision integer Revision True
(Revision)

Returns:

GetSubTask
Summary: Get subtask
Description: Retrieves a specific subtask

Syntax:
Wunderlist.GetSubTask (string id)

Parameters:
Name Type Summary Required Related
Action
id string Subtask ID True
(Subtask ID)

Returns:

2535 | P a g e
 Wunderlist

Type:Subtask
Description: Model for Subtask

UpdateSubTask
Summary: Update a subtask
Description: Updates a specific subtask

Syntax:
Wunderlist.UpdateSubTask (integer id, UpdateSubtask post)

Parameters:
Name Type Summary Required Related
Action
id integer Subtask ID True
(Subtask ID)
post UpdateSubtask True

Returns:
Type:Subtask
Description: Model for Subtask

DeleteSubTask
Summary: Delete a subtask
Description: Deletes a specific subtask

Syntax:
Wunderlist.DeleteSubTask (integer id, integer revision)

2536 | P a g e
 Wunderlist

Parameters:
Name Type Summary Required Related
Action
id integer Subtask ID True
(Subtask ID)
revision integer Revision True
(Revision)

Returns:

GetNote
Summary: Get a note
Description: Retrieve a specific note

Syntax:
Wunderlist.GetNote (string id)

Parameters:
Name Type Summary Required Related
Action
id string Note ID True
(Note ID)

Returns:
Type:Note
Description: Model for Note

UpdateNote
Summary: Update a note

2537 | P a g e
 Wunderlist

Description: Update a specific note

Syntax:
Wunderlist.UpdateNote (integer id, UpdateNote post)

Parameters:
Name Type Summary Required Related
Action
id integer Note ID True
(Note ID)
post UpdateNote True

Returns:
Type:Note
Description: Model for Note

DeleteNote
Summary: Delete a note
Description: Delete a specific note

Syntax:
Wunderlist.DeleteNote (integer id, integer revision)

Parameters:
Name Type Summary Required Related
Action
id integer Note ID True

2538 | P a g e
 Wunderlist

(Note ID)
revision integer Revision True
(Revision)

Returns:

GetComment
Summary: Get task comment
Description: Retrieve a specific task comment

Syntax:
Wunderlist.GetComment (string id)

Parameters:
Name Type Summary Required Related
Action
id string Comment ID True
(Comment
ID)

Returns:
Type:Comment
Description: Model for Task Comment

UpdateReminder
Summary: Update a reminder
Description: Update a specific reminder

Syntax:

2539 | P a g e
 Wunderlist

Wunderlist.UpdateReminder (integer id, UpdateReminder post)

Parameters:
Name Type Summary Required Related
Action
id integer Reminder ID True
(Reminder ID)
post UpdateReminder True

Returns:
Type:Reminder
Description: Model for Reminder

DeleteReminder
Summary: Delete a reminder
Description: Delete a specific reminder

Syntax:
Wunderlist.DeleteReminder (integer id, integer revision)

Parameters:
Name Type Summary Required Related
Action
id integer ID of the True
(Reminder reminder.
ID)
revision integer Revision True

2540 | P a g e
 Wunderlist

(Revision)

Returns:

Triggers:
Trigger TriggerTaskDue
Summary: When a task is due
Description: Triggers a new flow when a task in the list is due

Syntax:
Wunderlist.TriggerTaskDue (integer list_id)

Parameters:
Name Type Summary Required Related
Action
list_id integer List ID True RetrieveLists
(List ID)

Returns:
Type:array of (Task)

Trigger TriggerTaskNew
Summary: When a new task is created
Description: Triggers a new flow when a new task is created in the list

Syntax:
Wunderlist.TriggerTaskNew (integer list_id)

Parameters:
2541 | P a g e
 Wunderlist

Name Type Summary Required Related

Action
list_id integer List ID True RetrieveLists
(List ID)

Returns:
Type:array of (Task)

Trigger TriggerReminder
Summary: When a reminder occurs
Description: Triggers a new flow when a reminder occurs

Syntax:
Wunderlist.TriggerReminder (integer list_id, [Optional]integer
task_id)

Parameters:
Name Type Summary Required Related
Action
list_id integer List ID True RetrieveLists
(List ID)
task_id integer Task ID False ListTasks
(Task ID)

Returns:
Type:array of (Reminder)

2542 | P a g e
 Wunderlist

Comment
Summary:
Description: Model for Task Comment

Properties:
Name Type Summary
id integer ID

task_id integer Task ID

revision integer Revision

text string Text

type string Type

created_at string(date-time) Created At

2543 | P a g e
 Wunderlist

CreatedList
Summary:
Description: Model for create list response

Properties:
Name Type Summary
id integer ID

created_at string(date-time) Created At

title string Title

revision integer Revision

type string Type

2544 | P a g e
 Wunderlist

CreatedReminder
Summary:
Description: Model for create reminder response

Properties:
Name Type Summary
id integer ID

date string(date-time) Date

task_id integer Task ID

revision integer Revision

created_at string(date-time) Created At

updated_at string(date-time) Updated At

2545 | P a g e
 Wunderlist

File
Summary:
Description: Model for File

Properties:
Name Type Summary
id integer ID

url string URL

task_id integer Task ID

list_id integer List ID

user_id integer User ID

file_name string Filename

content_type string Content Type

file_size integer File Size

local_created_at string(date-time) File creation time

specified by the user
created_at string(date-time) Created At

updated_at string(date-time) Updated At

type string Type

2546 | P a g e
 Wunderlist

revision integer Revision

2547 | P a g e
 Wunderlist

List
Summary:
Description: Model for List

Properties:
Name Type Summary
id integer ID

created_at string(date-time) Created At

title string Title

list_type string List Type

type string Type

revision integer Revision

2548 | P a g e
 Wunderlist

NewComment
Summary:
Description:

Properties:
Name Type Summary
list_id integer List ID

task_id integer Task ID

text string Text

2549 | P a g e
 Wunderlist

NewList
Summary:
Description:

Properties:
Name Type Summary
title string Title

2550 | P a g e
 Wunderlist

NewNote
Summary:
Description:

Properties:
Name Type Summary
list_id integer List ID

task_id integer Task ID

content string Text content for the note

2551 | P a g e
 Wunderlist

NewReminder
Summary:
Description:

Properties:
Name Type Summary
list_id integer List ID

task_id integer Task ID

date string(date-time) Date

2552 | P a g e
 Wunderlist

NewSubtask
Summary:
Description:

Properties:
Name Type Summary
list_id integer List ID

task_id integer Task ID

title string Title

completed boolean Completed

2553 | P a g e
 Wunderlist

NewTask
Summary:
Description:

Properties:
Name Type Summary
list_id integer List ID

title string Title

assignee_id integer Assignee ID

completed boolean Completed

recurrence_type string Recurrence Type Values:

[day, week, month, year]
recurrence_count integer How many times the task
should occur
due_date string(date) Due Date

starred boolean Starred

2554 | P a g e
 Wunderlist

Note
Summary:
Description: Model for Note

Properties:
Name Type Summary
id integer ID

task_id integer Task ID

content string Content

created_at string(date-time) Created At

updated_at string(date-time) Updated At

revision integer Revision

2555 | P a g e
 Wunderlist

Reminder
Summary:
Description: Model for Reminder

Properties:
Name Type Summary
id integer ID

date string(date-time) Date

task_id integer Task ID

revision integer Revision

type string Type

created_at string(date-time) Created At

updated_at string(date-time) Updated At

2556 | P a g e
 Wunderlist

Subtask
Summary:
Description: Model for Subtask

Properties:
Name Type Summary
id integer ID

task_id integer Task ID

created_at string(date-time) Created At

created_by_id integer Created By

revision integer Revision

completed boolean Completed

completed_at string(date-time) Completed At

title string Title

type string Type

2557 | P a g e
 Wunderlist

Task
Summary:
Description: Model for Task

Properties:
Name Type Summary
id integer Task ID

assignee_id integer Assignee ID

assigner_id integer Assigner ID

created_at string(date-time) Created At

created_by_id integer Created By

due_date string(date-time) Due Date

list_id integer List ID

revision integer Revision

starred boolean Starred

title string Title

2558 | P a g e
 Wunderlist

UpdateList
Summary:
Description:

Properties:
Name Type Summary
revision integer Revision

title string Title

2559 | P a g e
 Wunderlist

UpdateNote
Summary:
Description:

Properties:
Name Type Summary
revision integer Revision

content string Content

2560 | P a g e
 Wunderlist

UpdateReminder
Summary:
Description:

Properties:
Name Type Summary
date string(date-time) Date

revision integer Revision

2561 | P a g e
 Wunderlist

UpdateSubtask
Summary:
Description:

Properties:
Name Type Summary
revision integer Revision

title string Title

completed boolean Completed

2562 | P a g e
 Wunderlist

UpdateTask
Summary:
Description:

Properties:
Name Type Summary
revision integer Revision

title string Title

assignee_id integer Assignee ID

completed boolean Completed

recurrence_type string Recurrence Type Values:

[day, week, month, year]
recurrence_count integer Recurrence Count

due_date string Due Date

starred boolean Starred

2563 | P a g e
 Yammer

Yammer
Yammer is a leading social network for businesses to get work done smarter
and faster. Connect to Yammer to access conversations in your enterprise
network.

Status: Production Tier: Standard Version: 1.0

Actions:
Name Summary
GetNetworks () Get my networks
GetGroups ([Optional]string Get groups
network_id, [Optional]integer
mine, [Optional]integer
showAllCompanyGroup)
GetAllMessages Get all messages
([Optional]string network_id,
[Optional]integer older_than,
[Optional]integer
newer_than,
[Optional]integer limit,
[advanced][Optional]integer
page)
PostMessage ([Optional]string Post message
network_id,
PostOperationRequest input)
GetMessagesFollowing Gets the messages from my Following feed
([Optional]string network_id,
[Optional]integer older_than,

2564 | P a g e
 Yammer

[Optional]integer
newer_than,
[Optional]integer limit,
[advanced][Optional]integer
page)
GetMessagesInGroup Gets messages in a group
([Optional]string network_id,
integer group_id,
[Optional]integer older_than,
[Optional]integer
newer_than,
[Optional]integer limit,
[advanced][Optional]integer
page)
TestConnection () Tests the connection

Triggers:
Name Summary
OnNewMessagesFollowing When there is a new message in my Following feed
([Optional]string network_id,
[internal][Optional]integer
triggerstate)
OnNewMessagesInGroup When there is a new message in a group
([Optional]string network_id,
integer group_id,
[internal][Optional]integer
triggerstate)

2565 | P a g e
 Yammer

Objects:
Name Summary
LikedBy
Message
MessageBody
MessageList
Network
PostOperationRequest
YammmerEntity

Actions:
GetNetworks
Summary: Get my networks
Description: Gets all the networks that the user belongs to

Syntax:
Yammer.GetNetworks ()

Returns:
Type:Network
Description: Network

GetGroups
Summary: Get groups
Description: Gets all groups. If mine = 1, get only groups to which the user belongs

Syntax:

2566 | P a g e
 Yammer

Yammer.GetGroups ([Optional]string network_id, [Optional]integer

mine, [Optional]integer showAllCompanyGroup)

Parameters:
Name Type Summary Required Related
Action
network_id string Network ID False GetNetworks
(Network ID)
mine integer(int32) Used for False
(mine) getting
groups which
user is part
of
showAllCompanyGroup integer(int32) Used for False
(Show All showing All
Company Company
Group) Group

Returns:
Type:YammmerEntity
Description: Yammer Entity

GetAllMessages
Summary: Get all messages
Description: Get all public messages in the logged in user's Yammer network.
Corresponds to "All" conversations in the Yammer web interface.

Syntax:

2567 | P a g e
 Yammer

Yammer.GetAllMessages ([Optional]string network_id,

[Optional]integer older_than, [Optional]integer newer_than,
[Optional]integer limit, [advanced][Optional]integer page)

Parameters:
Name Type Summary Required Related
Action
network_id string Network ID False GetNetworks
(Network ID)
older_than integer(int64) Returns messages False
(Older than) older than the
message ID specified
as a numeric string.
This is useful for
paginating messages.
For example, if
you’re currently
viewing 20 messages
and the oldest is
number 2912, you
could append
“?older_than=2912″
to your request to
get the 20 messages
prior to those you’re
seeing.
newer_than integer(int64) Returns messages False
(Newer than) newer than the
message ID specified

2568 | P a g e
 Yammer

as a numeric string.
This should be used
when polling for new
messages. If you’re
looking at messages,
and the most recent
message returned is
3516, you can make
a request with the
parameter
“?newer_than=3516″
to ensure that you
do not get duplicate
copies of messages
already on your
page.
limit integer(int32) Return only the False
(Limit) specified number of
messages.
page integer(int32) Get the page False
(Page) specified. If returned
data is greater than
the limit, you can use
this field to access
subsequent pages

Returns:
Type:MessageList
Description: List of messages

2569 | P a g e
 Yammer

PostMessage
Summary: Post message
Description: Post a Message to a Group or All Company Feed. If group ID is provided,
message will be posted to the specified group else it will be posted in All Company
Feed.

Syntax:
Yammer.PostMessage ([Optional]string network_id,
PostOperationRequest input)

Parameters:
Name Type Summary Required Related
Action
network_id string Network ID False GetNetworks
(Network ID)
input PostOperationRequest Represents a True
post request
for Yammer
Connector to
post to
yammer

Returns:
Type:MessageList
Description: List of messages

GetMessagesFollowing
Summary: Gets the messages from my Following feed

2570 | P a g e
 Yammer

Description: Gets the messages from Following feed which is conversations involving
people, groups and topics that the user is following

Syntax:
Yammer.GetMessagesFollowing ([Optional]string network_id,
[Optional]integer older_than, [Optional]integer newer_than,
[Optional]integer limit, [advanced][Optional]integer page)

Parameters:
Name Type Summary Required Related
Action
network_id string Network ID False GetNetworks
(Network ID)
older_than integer(int64) Returns messages False
(Older than) older than the
message ID specified
as a numeric string.
This is useful for
paginating messages.
For example, if
you’re currently
viewing 20 messages
and the oldest is
number 2912, you
could append
“?older_than=2912″
to your request to
get the 20 messages

2571 | P a g e
 Yammer

prior to those you’re

seeing.
newer_than integer(int64) Returns messages False
(Newer than) newer than the
message ID specified
as a numeric string.
This should be used
when polling for new
messages. If you’re
looking at messages,
and the most recent
message returned is
3516, you can make
a request with the
parameter
“?newer_than=3516″
to ensure that you
do not get duplicate
copies of messages
already on your
page.
limit integer(int32) Return only the False
(Limit) specified number of
messages.
page integer(int32) Get the page False
(Page) specified. If returned
data is greater than
the limit, you can use

2572 | P a g e
 Yammer

this field to access

subsequent pages

Returns:
Type:MessageList
Description: List of messages

GetMessagesInGroup
Summary: Gets messages in a group
Description: Gets the messages posted in a group

Syntax:
Yammer.GetMessagesInGroup ([Optional]string network_id, integer
group_id, [Optional]integer older_than, [Optional]integer
newer_than, [Optional]integer limit, [advanced][Optional]integer
page)

Parameters:
Name Type Summary Required Related
Action
network_id string Network ID False GetNetworks
(Network ID)
group_id integer(int64) Group ID True GetGroups
(Group ID)
older_than integer(int64) Returns messages False
(Older than) older than the
message ID specified
as a numeric string.
This is useful for

2573 | P a g e
 Yammer

paginating messages.
For example, if
you’re currently
viewing 20 messages
and the oldest is
number 2912, you
could append
“?older_than=2912″
to your request to
get the 20 messages
prior to those you’re
seeing.
newer_than integer(int64) Returns messages False
(Newer than) newer than the
message ID specified
as a numeric string.
This should be used
when polling for new
messages. If you’re
looking at messages,
and the most recent
message returned is
3516, you can make
a request with the
parameter
“?newer_than=3516″
to ensure that you
do not get duplicate
copies of messages

2574 | P a g e
 Yammer

already on your
page.
limit integer(int32) Return only the False
(Limit) specified number of
messages.
page integer(int32) Get the page False
(Page) specified. If returned
data is greater than
the limit, you can use
this field to access
subsequent pages

Returns:
Type:MessageList
Description: List of messages

TestConnection
Summary: Tests the connection
Description: Tests the connection

Syntax:
Yammer.TestConnection ()

Returns:

Triggers:
Trigger OnNewMessagesFollowing
Summary: When there is a new message in my Following feed

2575 | P a g e
 Yammer

Description: Triggers a new flow when there is a new message in my Following feed
which is conversations involving people, groups and topics that the user is following

Syntax:
Yammer.OnNewMessagesFollowing ([Optional]string network_id,
[internal][Optional]integer triggerstate)

Parameters:
Name Type Summary Required Related
Action
network_id string Network ID False GetNetworks
(Network ID)
triggerstate integer(int32) Trigger state False
(Trigger
state)

Returns:
Type:MessageList
Description: List of messages

Trigger OnNewMessagesInGroup
Summary: When there is a new message in a group
Description: Triggers a new flow when a new message is posted in a group

Syntax:
Yammer.OnNewMessagesInGroup ([Optional]string network_id,
integer group_id, [internal][Optional]integer triggerstate)

Parameters:

2576 | P a g e
 Yammer

Name Type Summary Required Related

Action
network_id string Network ID False GetNetworks
(Network ID)
group_id integer(int64) Group ID True GetGroups
(Group ID)
triggerstate integer(int32) Trigger state False
(Trigger
state)

Returns:
Type:MessageList
Description: List of messages

2577 | P a g e
 Yammer

LikedBy
Summary:
Description: Liked By

Properties:
Name Type Summary
count integer(int32) Count
Count
names array of (string)
Names

2578 | P a g e
 Yammer

Message
Summary:
Description: Yammer Message

Properties:
Name Type Summary
id integer(int64) ID associated with the
Message ID post
content_excerpt string Text Content of the post
Message Text
sender_id integer(int64) Unique ID of user who
Sender ID posted the message
replied_to_id integer(int64) ID of the message to
Replied to ID which this message is a
reply
created_at string Time at which the
Created At message was created
network_id integer(int32) Network ID
Network ID
message_type string Message type
Message type
sender_type string Sender Type
Sender Type
url string(uri) API url of the post
Url
web_url string(uri) Web url of the post
Web Url
group_id integer(int64) Unique ID of group who
Group ID posted the message

2579 | P a g e
 Yammer

body MessageBody Message Body

thread_id integer(int64) Unique ID of thread

Thread ID
direct_message boolean Flag to specify if the post
Direct message is a a direct message
client_type string Client Type
Client Type
client_url string(uri) Client URL
Client URL
language string Language
Language
notified_user_ids array of (integer(int64)) Details of users notified
Tagged User Details
privacy string Privacy
Privacy
liked_by LikedBy Liked By

system_message boolean Flag to specify if the post

Is System Message is a system generated
message or not

2580 | P a g e
 Yammer

MessageBody
Summary:
Description: Message Body

Properties:
Name Type Summary
parsed string Parsed text
parsed
plain string Plain text
plain
rich string Rich Text
rich

2581 | P a g e
 Yammer

MessageList
Summary:
Description: List of messages

Properties:
Name Type Summary
messages array of (Message) messages
Messages

2582 | P a g e
 Yammer

Network
Summary:
Description: Network

Properties:
Name Type Summary
id integer(int64) Network ID
Network ID
name string Network Name
Network Name
permalink string Full Name
Full Name

2583 | P a g e
 Yammer

PostOperationRequest
Summary:
Description: Represents a post request for Yammer Connector to post to yammer

Properties:
Name Type Summary
group_id integer(int64) The group to post a
Group ID message to (0 = All
Company/Network)
body string Your message to be posted
Message Text into your network
replied_to_id integer(int64) The message ID this
Replied to id message is in reply to
direct_to_id integer(int64) If set, a private message
Direct to id will be sent directly to the
user with the indicated ID
broadcast boolean Post message as an
Broadcast announcement to all users
in a group
title string Title of the message to be
Title posted
topic1 string Topic to apply to the
Topic 1 message
topic2 string Topic to apply to the
Topic 2 message
topic3 string Topic to apply to the
Topic 3 message
topic4 string Topic to apply to the
Topic 4 message

2584 | P a g e
 Yammer

topic5 string Topic to apply to the

Topic 5 message
topic6 string Topic to apply to the
Topic 6 message
topic7 string Topic to apply to the
Topic 7 message
topic8 string Topic to apply to the
Topic 8 message
topic9 string Topic to apply to the
Topic 9 message
topic10 string Topic to apply to the
Topic 10 message
topic11 string Topic to apply to the
Topic 11 message
topic12 string Topic to apply to the
Topic 12 message
topic13 string Topic to apply to the
Topic 13 message
topic14 string Topic to apply to the
Topic 14 message
topic15 string Topic to apply to the
Topic 15 message
topic16 string Topic to apply to the
Topic 16 message
topic17 string Topic to apply to the
Topic 17 message
topic18 string Topic to apply to the
Topic 18 message

2585 | P a g e
 Yammer

topic19 string Topic to apply to the

Topic 19 message
topic20 string Topic to apply to the
Topic 20 message

2586 | P a g e
 Yammer

YammmerEntity
Summary:
Description: Yammer Entity

Properties:
Name Type Summary
type string Description
Description
id integer(int64) Group ID
Group ID
full_name string Full Name
Full Name

2587 | P a g e
 YouTube

YouTube
YouTube allows billions of people to discover, watch and share originally-
created videos. YouTube provides a forum for people to connect, inform, and
inspire others across the globe and acts as a distribution platform for original
content creators and advertisers large and small.

Status: Preview Tier: Standard Version: 1.2

Actions:
Name Summary
ListSubscriptions () List channels

Triggers:
Name Summary
OnNewVideoInChannel (string When a video is uploaded by a channel
channelId)
OnMyNewVideo () When I upload a video
OnNewVideoMatchingSearch When a new video matches a search
(string q)

Objects:
Name Summary
Subscription
SubscriptionList
Video
VideoList
VideoSnippet

2588 | P a g e
 YouTube

Actions:
ListSubscriptions
Summary: List channels
Description: Lists all channels which the authenticated user subscribes to

Syntax:
YouTube.ListSubscriptions ()

Returns:
Type:SubscriptionList
Description: A YouTube subscriptionListResponse object

Triggers:
Trigger OnNewVideoInChannel
Summary: When a video is uploaded by a channel
Description: Triggers a flow when a video is uploaded by a channel

Syntax:
YouTube.OnNewVideoInChannel (string channelId)

Parameters:
Name Type Summary Required Related Action
channelId string Unique ID of True ListSubscriptions
(Channel the channel to
Id) watch for new
videos

Returns:

2589 | P a g e
 YouTube

Type:VideoList
Description: A YouTube videoListResponse object

Trigger OnMyNewVideo
Summary: When I upload a video
Description: Triggers a flow when you upload a video to your channel

Syntax:
YouTube.OnMyNewVideo ()

Returns:
Type:VideoList
Description: A YouTube videoListResponse object

Trigger OnNewVideoMatchingSearch
Summary: When a new video matches a search
Description: Triggers a flow when a new video matches a search

Syntax:
YouTube.OnNewVideoMatchingSearch (string q)

Parameters:
Name Type Summary Required Related
Action
q string The search query True
(Query)

Returns:
Type:VideoList

2590 | P a g e
 YouTube

Description: A YouTube videoListResponse object

2591 | P a g e
 YouTube

Subscription
Summary:
Description: A YouTube subscription object

Properties:
Name Type Summary
channelId string The unique ID of the
Channel ID channel
title string The title of the channel
Channel Title

2592 | P a g e
 YouTube

SubscriptionList
Summary:
Description: A YouTube subscriptionListResponse object

Properties:
Name Type Summary
items array of (Subscription) Subscriptions in the list
Items

2593 | P a g e
 YouTube

Video
Summary:
Description: A YouTube video object

Properties:
Name Type Summary
id string The identifier of the video
Video ID
htmlLink string A link to the video
HTML Link
snippet VideoSnippet Model of a concise
summary of the video

2594 | P a g e
 YouTube

VideoList
Summary:
Description: A YouTube videoListResponse object

Properties:
Name Type Summary
items array of (Video) Videos in the list
Items

2595 | P a g e
 YouTube

VideoSnippet
Summary:
Description: Model of a concise summary of the video

Properties:
Name Type Summary
title string The title of the video
Title
description string The description of the
Description video
channelTitle string The title of the channel
Channel Title
channelId string The identifier of the
Channel ID channel
publishedAt string(date-time) Videos in the list
Published At

2596 | P a g e
 PowerApps Tabular Data Source Connectors

PowerApps Tabular Data Source Connectors

These connectors implement the standard data source capabilities that enable the
creation of applications from data. They are commonly used to bind data to a Form
control or a Gallery. They support easily discovering the list of tables or collections
exposed by the service as well as performing CRUD in the data through formulas such
as: Filter, Lookup, NewForm, EditForm, SubmitForm, ResetForm, or formulas that
allow more control such as Patch, Defaults and others.

2597 | P a g e
 Common Data Service

Common Data Service

Provides access to the org-based database on the Microsoft Common Data
Service

Status: Production Tier: Premium Version: 1.0

Capabilities
Server Filter Functions Supported:
Equal NotEqual GreaterThan GreaterThanOrEqual
LessThan LessThanOrEqual And Or

2598 | P a g e
 DB2

DB2
Microsoft Connector for DB2 integrates Azure applications with resources
stored in an IBM DB2 database. Connector supports SELECT, INSERT, UPDATE,
and DELETE operations.

Status: Preview Tier: Premium Version: 1.0

Capabilities
Server Filter Functions Supported:
Equal NotEqual GreaterThan GreaterThanOrEqual
LessThan LessThanOrEqual And Or

2599 | P a g e
 Dynamics 365

Dynamics 365
Connect to Dynamics 365 to view the data.

Status: Production Tier: Standard Version: 1.0

Capabilities
Server Filter Functions Supported:
Equal NotEqual GreaterThan GreaterThanOrEqual
LessThan LessThanOrEqual And Or
Contains StartsWith EndsWith Length
IndexOf Replace Substring SubstringOf
ToLower ToUpper Trim Concat
Year Month Day Hour
Minute Second Date Time
Now TotalOffsetMinutes TotalSeconds Floor
Ceiling Round Not Negate
Addition Subtraction Multiplication Division
Modulo Null

2600 | P a g e
 Dynamics 365 for Financials

Dynamics 365 for Financials

Dynamics 365 for Financials is a business management solution for small and
mid-sized organizations that automates and streamlines business processes
and helps you manage your business.

Status: Preview Tier: Standard Version: 1.0

Capabilities
Server Filter Functions Supported:
Equal NotEqual GreaterThan GreaterThanOrEqual
LessThan LessThanOrEqual And Or
Contains StartsWith EndsWith Length
IndexOf Replace Substring SubstringOf
ToLower ToUpper Trim Concat
Year Month Day Hour
Minute Second Floor Ceiling
Round Not Negate

2601 | P a g e
 Dynamics 365 for Operations

Dynamics 365 for Operations

Microsoft Dynamics 365 for Operations connector provides access to data
entities.

Status: Preview Tier: Standard Version: 1.0

Capabilities
Server Filter Functions Supported:
Equal NotEqual GreaterThan GreaterThanOrEqual
LessThan LessThanOrEqual And Or

2602 | P a g e
 Dynamics NAV

Dynamics NAV
Dynamics NAV is a business management solution for small and mid-sized
organizations that automates and streamlines business processes and helps
you manage your business.

Status: Preview Tier: Standard Version: 1.0

Capabilities
Server Filter Functions Supported:
Equal NotEqual GreaterThan GreaterThanOrEqual
LessThan LessThanOrEqual And Or
Contains StartsWith EndsWith Length
IndexOf Replace Substring SubstringOf
ToLower ToUpper Trim Concat
Year Month Day Hour
Minute Second Date Time
Now TotalOffsetMinutes TotalSeconds Floor
Ceiling Round Not Negate
Addition Subtraction Multiplication Division
Modulo Null

2603 | P a g e
 Excel

Excel
Excel Connector

Status: Production Tier: Standard Version: 1.0

Capabilities
Server Filter Functions Supported:
Equal NotEqual GreaterThan GreaterThanOrEqual
LessThan LessThanOrEqual And Or

2604 | P a g e
 Google Sheets

Google Sheets
Connect to Google Sheets to manage your spreadsheets. You can create, edit,
and collaborate with others on spreadsheets.

Status: Production Tier: Standard Version: 1.0

Capabilities
Server Filter Functions Supported:
No capabilities

2605 | P a g e
 Informix

Informix
Microsoft Connector for Informix integrates Azure applications with resources
stored in an IBM Informix database. Connector supports SELECT, INSERT,
UPDATE, and DELETE operations.

Status: Preview Tier: Premium Version: 1.0

Capabilities
Server Filter Functions Supported:
Equal NotEqual GreaterThan GreaterThanOrEqual
LessThan LessThanOrEqual And Or

2606 | P a g e
 Oracle Database

Oracle Database
Oracle Database is a relational database management system developed by
Oracle. Connect to on-premise Oracle Database to perform various actions
such as create, update, get, and delete on rows in a table.

Status: Preview Tier: Premium Version: 1.0

Capabilities
Server Filter Functions Supported:
Equal NotEqual GreaterThan GreaterThanOrEqual
LessThan LessThanOrEqual And Or
Contains StartsWith EndsWith Length
IndexOf Replace Substring SubstringOf
ToLower ToUpper Trim Concat
Year Month Day Hour
Minute Second Date Time
Now TotalOffsetMinutes TotalSeconds Floor
Ceiling Round Not Negate
Addition Subtraction Multiplication Division
Modulo Null

2607 | P a g e
 Salesforce

Salesforce
The Salesforce Connector provides an API to work with Salesforce objects.

Status: Production Tier: Premium Version: 1.0

Capabilities
Server Filter Functions Supported:
Equal NotEqual GreaterThan GreaterThanOrEqual
LessThan LessThanOrEqual And Or
Contains StartsWith EndsWith Length
IndexOf Replace Substring SubstringOf
ToLower ToUpper Trim Concat
Year Month Day Hour
Minute Second Date Time
Now TotalOffsetMinutes TotalSeconds Floor
Ceiling Round Not Negate
Addition Subtraction Multiplication Division
Modulo Null

2608 | P a g e
 SharePoint

SharePoint
SharePoint helps organizations share and collaborate with colleagues,
partners, and customers. You can connect to SharePoint Online or to an on-
premises SharePoint 2013 or 2016 farm using the On-Premises Data Gateway
to manage documents and list items.

Status: Production Tier: Standard Version: 1.0

Capabilities
Server Filter Functions Supported:
Equal NotEqual GreaterThan GreaterThanOrEqual
LessThan LessThanOrEqual And Or
Contains StartsWith EndsWith Length
IndexOf Replace Substring SubstringOf
ToLower ToUpper Trim Concat
Year Month Day Hour
Minute Second Date Time
Now TotalOffsetMinutes TotalSeconds Floor
Ceiling Round Not Negate
Addition Subtraction Multiplication Division
Modulo Null

2609 | P a g e
 SQL Server

SQL Server
Microsoft SQL Server is a relational database management system developed
by Microsoft. Connect to SQL Server to manage data. You can perform various
actions such as create, update, get, and delete on rows in a table.

Status: Production Tier: Standard Version: 1.0

Capabilities
Server Filter Functions Supported:
Equal NotEqual GreaterThan GreaterThanOrEqual
LessThan LessThanOrEqual And Or
Contains StartsWith EndsWith Length
IndexOf Replace Substring SubstringOf
ToLower ToUpper Trim Concat
Year Month Day Hour
Minute Second Date Time
Now TotalOffsetMinutes TotalSeconds Floor
Ceiling Round Not Negate
Addition Subtraction Multiplication Division
Modulo Null

2610 | P a g e
 UserVoice

UserVoice
UserVoice is a product management and customer support tool that allows
businesses to build a suggestions portal for their users to submit feature ideas,
build a ticketing system for customer support and build articles knowledge
base for users.

Status: Preview Tier: Premium Version: 1.0

Capabilities
Server Filter Functions Supported:
Equal NotEqual GreaterThan GreaterThanOrEqual
LessThan LessThanOrEqual And Or
Contains StartsWith EndsWith Length
IndexOf Replace Substring SubstringOf
ToLower ToUpper Trim Concat
Year Month Day Hour
Minute Second Date Time
Now TotalOffsetMinutes TotalSeconds Floor
Ceiling Round Not Negate
Addition Subtraction Multiplication Division
Modulo Null

2611 | P a g e
 Zendesk

Zendesk
Zendesk builds software for better customer relationships. With multiple
products in its portfolio, Zendesk provides a customer service and support
ticketing platform that gives businesses the ability to handle customer calls,
emails, and other technical inquiries from a unified interface.

Status: Preview Tier: Premium Version: 1.0

Capabilities
Server Filter Functions Supported:
Equal NotEqual GreaterThan GreaterThanOrEqual
LessThan LessThanOrEqual And Or
Contains StartsWith EndsWith Length
IndexOf Replace Substring SubstringOf
ToLower ToUpper Trim Concat
Year Month Day Hour
Minute Second Date Time
Now TotalOffsetMinutes TotalSeconds Floor
Ceiling Round Not Negate
Addition Subtraction Multiplication Division
Modulo Null

2612 | P a g e
 PowerApps Blob Connectors

PowerApps Blob Connectors

These connectors expose a standard way to interact with content, such as files and
folders on different locations and service providers. When used in conjunction with the
Excel Connector they allow you to create applications that store the data in Excel
Spreadsheets on such locations.

2613 | P a g e
 Azure Blob Storage

Azure Blob Storage

Microsoft Azure Storage provides a massively scalable, durable, and highly
available storage for data on the cloud, and serves as the data storage solution
for modern applications. Connect to Blob Storage to perform various
operations such as create, update, get and delete on blobs in your Azure Storage
account.

Status: Production Tier: Standard Version: 1.0

2614 | P a g e
 Box

Box
Box™ is a service that keeps your files safe, synced, and easy to share. Connect
to Box to manage your files. You can perform various actions such as upload,
update, get, and delete files in Box.

Status: Production Tier: Standard Version: 1.0

2615 | P a g e
 Dropbox

Dropbox
Dropbox is a service that keeps your files safe, synced, and easy to share.
Connect to Dropbox to manage your files. You can perform various actions
such as upload, update, get, and delete files in Dropbox.

Status: Production Tier: Standard Version: 1.0

2616 | P a g e
 File System

File System
The File Connector uses the on premises gateway to transfer shared files
between computer with gateway installed and Azure.

Status: Preview Tier: Standard Version: 1.0

2617 | P a g e
 FTP

FTP
The File Transfer Protocol (FTP) is a standard network protocol used to
transfer computer files between a client and server on a computer network.
FTP is built on a client-server model architecture and uses separate control
and data connections between the client and the server.

Status: Production Tier: Standard Version: 1.0

2618 | P a g e
 Google Drive

Google Drive
Google Drive is a file storage and synchronization service created by Google. It
allows users to store files in the cloud, share files, and edit documents,
spreadsheets, and presentations with collaborators.

Status: Production Tier: Standard Version: 1.0

2619 | P a g e
 OneDrive

OneDrive
Connect to OneDrive to manage your files. You can perform various actions
such as upload, update, get, and delete on files in OneDrive.

Status: Production Tier: Standard Version: 1.0

2620 | P a g e
 OneDrive for Business

OneDrive for Business

OneDrive for Business is a cloud storage, file hosting service that allows users
to sync files and later access them from a web browser or mobile device.
Connect to OneDrive for Business to manage your files. You can perform
various actions such as upload, update, get, and delete files.

Status: Production Tier: Standard Version: 1.0

2621 | P a g e
 SFTP

SFTP
Connect to SFTP API to send and receive files. You can perform various
operations such as create, update, get or delete files.

Status: Production Tier: Standard Version: 1.0

2622 | P a g e