Capsule CRM (Preview)

Online CRM for individuals, small businesses and sales teams wanting a simple, effective and affordable solution.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds
Frequency of trigger polls1120 seconds

Actions

Complete task

This operation is used to complete a task.

Create opportunity

This operation is used to create a new opportunity in your account.

Create organisation

This operation is used to create a new organisation in your Capsule account.

Create person

This operation is used to create a new person in your Capsule account.

Create task

This operation is used to create a new task.

Delete party

This operation is used to delete a party from your account.

DeleteOpportunity

This operation is used to delete an existing opportunity.

Get opportunity

This operation is used to retrieve all information about an opportunity.

Get party

This operation retrieves all information about an existing party.

List opportunities

This operation retrieves a list of all opportunities in your Capsule account.

List organizations

This operation is used to retrieve a list of all organisations in your account.

List parties

This operation is used to retrieve a list of all parties in your Capsule account.

List people

This operation is used to retrieve a list of all people in your Capsule account.

List tasks

This operation is used to retrieve a list of tasks.

Update opportunity

This operation is used to update information about an existing opportunity.

Update organisation

This operation is used to update information about an existing organisation.

Update person

This operation is used to update the information about an existing person in your Capsule account.

Complete task

This operation is used to complete a task.

Parameters

Name Key Required Type Description
Task Id
taskId True string

The id of the task

Returns

Name Path Type Description
task
task Task_Response

Create opportunity

This operation is used to create a new opportunity in your account.

Parameters

Name Key Required Type Description
Name
name True string

This operation is used to create a new opportunity in your account.

Party Id
id True integer

Pick a party.

Id
id True integer

Pick a milestone.

Description
description string

This operation is used to create a new opportunity in your account.

Duration Basis
durationBasis string

This operation is used to create a new opportunity in your account.

Duration
duration string

This operation is used to create a new opportunity in your account.

Expected Close Date
expectedCloseOn string

yyyy-MM-dd

Winning Probability
probability integer

This operation is used to create a new opportunity in your account.

Amount
amount integer

This operation is used to create a new opportunity in your account.

Currency
currency string

This operation is used to create a new opportunity in your account.

Returns

Name Path Type Description
opportunity
opportunity Opportunity_Response

Create organisation

This operation is used to create a new organisation in your Capsule account.

Parameters

Name Key Required Type Description
Name
name True string

This operation is used to create a new organisation in your Capsule account.

About
about string

This operation is used to create a new organisation in your Capsule account.

Phone Number
number string

This operation is used to create a new organisation in your Capsule account.

Phone Type
type string

This operation is used to create a new organisation in your Capsule account.

Email Address
address string

This operation is used to create a new organisation in your Capsule account.

Email Type
type string

This operation is used to create a new organisation in your Capsule account.

Website Address
address string

This operation is used to create a new organisation in your Capsule account.

Website Service
service string

This operation is used to create a new organisation in your Capsule account.

Website Type
type string

This operation is used to create a new organisation in your Capsule account.

Address Street
street string

This operation is used to create a new organisation in your Capsule account.

Address City
city string

This operation is used to create a new organisation in your Capsule account.

Address State
state string

This operation is used to create a new organisation in your Capsule account.

Address Zip
zip string

This operation is used to create a new organisation in your Capsule account.

Address Country
country string

This operation is used to create a new organisation in your Capsule account.

Address Type
type string

This operation is used to create a new organisation in your Capsule account.

Tags
tags string

Comma-separated list of tags.

Returns

Name Path Type Description
party
party Party_Response

Create person

This operation is used to create a new person in your Capsule account.

Parameters

Name Key Required Type Description
Last Name
lastName True string

This operation is used to create a new person in your Capsule account.

First Name
firstName string

This operation is used to create a new person in your Capsule account.

Title
title string

This operation is used to create a new person in your Capsule account.

Job Title
jobTitle string

This operation is used to create a new person in your Capsule account.

About
about string

This operation is used to create a new person in your Capsule account.

Organisation Id
organisation string

Pick an organisation.

Phone Number
number string

This operation is used to create a new person in your Capsule account.

Phone Type
type string

This operation is used to create a new person in your Capsule account.

Email Address
address string

This operation is used to create a new person in your Capsule account.

Email Type
type string

This operation is used to create a new person in your Capsule account.

Website Address
address string

This operation is used to create a new person in your Capsule account.

Website Service
service string

This operation is used to create a new person in your Capsule account.

Website Type
type string

This operation is used to create a new person in your Capsule account.

Address Street
street string

This operation is used to create a new person in your Capsule account.

Address City
city string

This operation is used to create a new person in your Capsule account.

Address State
state string

This operation is used to create a new person in your Capsule account.

Address Zip
zip string

This operation is used to create a new person in your Capsule account.

Address Country
country string

This operation is used to create a new person in your Capsule account.

Address Type
type string

This operation is used to create a new person in your Capsule account.

Tags
tags string

Comma-separated list of tags.

Returns

Name Path Type Description
party
party Party_Response

Create task

This operation is used to create a new task.

Parameters

Name Key Required Type Description
Description
description True string

This operation is used to create a new task.

Due Date
dueOn True string

yyyy-MM-dd

Due Time
dueTime string

hh:mm:ss

Details
detail string

This operation is used to create a new task.

Id
id integer

This operation is used to create a new task.

Returns

Name Path Type Description
task
task Task_Response

Delete party

This operation is used to delete a party from your account.

Parameters

Name Key Required Type Description
Party Id
personId True string

The id of the party

DeleteOpportunity

This operation is used to delete an existing opportunity.

Parameters

Name Key Required Type Description
Opportunity Id
opportunityId True string

The id of the opportunity

Get opportunity

This operation is used to retrieve all information about an opportunity.

Parameters

Name Key Required Type Description
Opportunity Id
opportunityId True string

The id of the opportunity

Returns

Name Path Type Description
opportunity
opportunity Opportunity_Response

Get party

This operation retrieves all information about an existing party.

Parameters

Name Key Required Type Description
Party Id
personId True string

The id of the party

Returns

Name Path Type Description
party
party Party_Response

List opportunities

This operation retrieves a list of all opportunities in your Capsule account.

Returns

Name Path Type Description
opportunities
opportunities array of Opportunity_Response

List organizations

This operation is used to retrieve a list of all organisations in your account.

Returns

List parties

This operation is used to retrieve a list of all parties in your Capsule account.

Returns

List people

This operation is used to retrieve a list of all people in your Capsule account.

Returns

List tasks

This operation is used to retrieve a list of tasks.

Returns

Name Path Type Description
tasks
tasks array of Task_Response

Update opportunity

This operation is used to update information about an existing opportunity.

Parameters

Name Key Required Type Description
Opportunity Id
opportunityId True string

The id of the opportunity

Name
name string

The id of the opportunity

Party Id
id True integer

Pick a party.

Milestone Id
id True integer

Pick a milestone.

Description
description string

The id of the opportunity

Duration Basis
durationBasis string

The id of the opportunity

Duration
duration string

The id of the opportunity

Expected Close Date
expectedCloseOn string

yyyy-MM-dd

Winning Probability
probability integer

The id of the opportunity

Amount
amount integer

The id of the opportunity

Currency
currency string

The id of the opportunity

Returns

Name Path Type Description
opportunity
opportunity Opportunity_Response

Update organisation

This operation is used to update information about an existing organisation.

Parameters

Name Key Required Type Description
Party Id
id True string

The id of the party

Name
name string

The id of the party

About
about string

The id of the party

Phone Number
number string

The id of the party

Phone Type
type string

The id of the party

Email Address
address string

The id of the party

Email Type
type string

The id of the party

Website Address
address string

The id of the party

Website Service
service string

The id of the party

Website Type
type string

The id of the party

Address Street
street string

The id of the party

Address City
city string

The id of the party

Address State
state string

The id of the party

Address Zip
zip string

The id of the party

Address Country
country string

The id of the party

Address Type
type string

The id of the party

Tags
tags string

Comma-separated list of tags.

Returns

Name Path Type Description
party
party Party_Response

Update person

This operation is used to update the information about an existing person in your Capsule account.

Parameters

Name Key Required Type Description
Party Id
personId True string

The id of the party

Last Name
lastName string

The id of the party

First Name
firstName string

The id of the party

Title
title string

The id of the party

Job Title
jobTitle string

The id of the party

About
about string

The id of the party

Organisation Id
organisation string

Pick an organisation.

Phone Number
number string

The id of the party

Phone Type
type string

The id of the party

Email Address
address string

The id of the party

Email Type
type string

The id of the party

Website Address
address string

The id of the party

Website Service
service string

The id of the party

Website Type
type string

The id of the party

Address Street
street string

The id of the party

Address City
city string

The id of the party

Address State
state string

The id of the party

Address Zip
zip string

The id of the party

Address Country
country string

The id of the party

Address Type
type string

The id of the party

Tags
tags string

Comma-separated list of tags.

Returns

Name Path Type Description
party
party Party_Response

Triggers

When a party is created

This operation triggers when a new party is created in your account.

When a task is created

This operation triggers when a task is created in your account.

When an opportunity is created

This operation triggers when a new opportunity is created in your account.

When an opportunity is updated

This operation triggers when an existing opportunity is updated in your account.

When a party is created

This operation triggers when a new party is created in your account.

Returns

When a task is created

This operation triggers when a task is created in your account.

Returns

When an opportunity is created

This operation triggers when a new opportunity is created in your account.

Returns

When an opportunity is updated

This operation triggers when an existing opportunity is updated in your account.

Returns

Definitions

Opportunity_Response

Name Path Type Description
Closed Date
closedOn string

yyyy-MM-dd

Created Date-Time
createdAt date-time

yyyy-MM-ddTHH:mm:ss.fffZ

Description
description string

Opportunity description.

Duration
duration integer

Opportunity duration.

Duration Basis
durationBasis string

Basis for the opportunity duration.

Expected Close Date
expectedCloseOn string

yyyy-MM-dd

Opportunity Id
id integer

Unique id of the opportunity.

Milestone Id
milestone.id integer

Unique id of the milestone.

Milestone Name
milestone.name string

Name of the milestone opportunity is in.

Opportunity Name
name string

Name of the opportunity.

Id
owner.id integer

Unique id of the user.

Name
owner.name string

Name of the user.

Username
owner.username string

Username of the user.

First Name
party.firstName string

First name when type is person.

Id
party.id integer

Unique id of the party.

Last Name
party.lastName string

Last name when type is person.

Picture URL
party.pictureURL string

Url that represents the profile picture for this party.

Type
party.type string

Person or organization.

Probability
probability integer

Probability of winning the opportunity.

Updated Date-Time
updatedAt date-time

yyyy-MM-ddTHH:mm:ss.fffZ

Amount the opportunity is worth.
value.amount float

amount

Currency
value.currency string

Currency type of the opportunity.

Listparties_Response

Name Path Type Description
parties
parties array of object

party

Organisation Name
parties.name string

Name of the organisation.

About
parties.about string

Organisation description.

Created Date-Time
parties.createdAt date-time

yyyy-MM-ddTHH:mm:ss.fffZ

First Name
parties.firstName string

Person's first name.

Party Id
parties.id integer

Unique id of the organisation.

Job Title
parties.jobTitle string

Person's job title.

Last Contacted Date-Time
parties.lastContactedAt string

yyyy-MM-ddTHH:mm:ss.fffZ

Last Name
parties.lastName string

Person's last name.

Organisation
parties.organisation string

Person's company.

Picture URL
parties.pictureURL string

Url where the image is located.

Title
parties.title string

Person's title.

Type
parties.type string

Person or organisation.

Updated Date-Time
parties.updatedAt date-time

yyyy-MM-ddTHH:mm:ss.fffZ

Party_Response

Name Path Type Description
Organisation Name
name string

Name of the organisation.

About
about string

Short description about the party.

addresses
addresses array of object

Array of addresses.

City
addresses.city string

Party address.

Country
addresses.country string

Party address.

State
addresses.state string

Party address.

Street
addresses.street string

Party address.

Type
addresses.type string

Party address.

Zip
addresses.zip string

Party address.

Created Date-Time
createdAt date-time

yyyy-MM-ddTHH:mm:ss.fffZ

emailAddresses
emailAddresses array of object

Array of email addresses.

Email Address
emailAddresses.address string

The actual email address.

Email Type
emailAddresses.type string

Home or work.

First Name
firstName string

Person's first name.

Party Id
id integer

Unique id of the party.

Job Title
jobTitle string

Person's job title.

Last Contacted at
lastContactedAt string

yyyy-MM-ddTHH:mm:ss.fffZ

Last Name
lastName string

Person's last name.

Organisation
organisation string

Organisation the party is associated with.

phoneNumbers
phoneNumbers array of object

Phone numbers,

Phone Number
phoneNumbers.number string

The actual phone number.

Phone Number Type
phoneNumbers.type string

Home, work, mobile, fax, or direct.

Picture URL
pictureURL string

Url that represents the location of the profile picture for this party.

Title
title string

Person's title.

Type
type string

Person or organisation.

Updated Date-Time
updatedAt date-time

yyyy-MM-ddTHH:mm:ss.fffZ

websites
websites array of object

websites

Website Address
websites.address string

Account username or profile page url.

Website Service
websites.service string

Url, skype, twitter, linkedin, facebook, xing, feed, google_plus, flickr, github or youtube.

Website Type
websites.type string

Home or work.

Task_Response

Name Path Type Description
Colour
category.colour string

Description of the task category.

Id
category.id integer

Id of the task category.

Name
category.name string

Name of the task category.

Completed Date-Time
completedAt string

yyyy-MM-ddTHH:mm:ss.fffZ

Completed By
completedBy string

Username of the person who completed this task.

Created Date-Time
createdAt date-time

yyyy-MM-ddTHH:mm:ss.fffZ

Description
description string

Short description about the task.

Detail
detail string

More details about the task.

Due Date
dueOn string

yyyy-MM-dd

Due Time
dueTime string

hh:mm:ss

Task Id
id integer

Unique id of the task.

Id
owner.id integer

Unique id of the user.

Name
owner.name string

Name of the user.

Username
owner.username string

Username of the user.

First Name
party.firstName string

First name, if person.

Id
party.id integer

Unique id of the party.

Last Name
party.lastName string

Last name, if person.

Picture URL
party.pictureURL string

Url that represents the location of the profile picture for this party.

Type
party.type string

Person or organisation.

Status
status string

Open, completed or pending.

Updated Date-Time
updatedAt date-time

yyyy-MM-ddTHH:mm:ss.fffZ