Capsule CRM (Preview)

Capsule CRM (Preview)

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

Note:

  • This is a Premium connector.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds
Frequency of trigger polls 1 120 seconds

Actions

Complete task

This operation is used to complete a task.

Required Parameters

Task Id
string
The id of the task

Returns

task
Task_Response
This operation is used to complete a task.

Create opportunity

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

Required Parameters

Name
string
Party Id
integer
Pick a party.
Id
integer
Pick a milestone.

Optional Parameters

Description
string
Duration Basis
string
Duration
string
Expected Close Date
string
yyyy-MM-dd
Winning Probability
integer
Amount
integer
Currency
string

Returns

opportunity
Opportunity_Response
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.

Required Parameters

Name
string

Optional Parameters

About
string
Phone Number
string
Phone Type
string
Email Address
string
Email Type
string
Website Address
string
Website Service
string
Website Type
string
Address Street
string
Address City
string
Address State
string
Address Zip
string
Address Country
string
Address Type
string
Tags
string
Comma-separated list of tags.

Returns

party
Party_Response
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.

Required Parameters

Last Name
string

Optional Parameters

First Name
string
Title
string
Job Title
string
About
string
Organisation Id
string
Pick an organisation.
Phone Number
string
Phone Type
string
Email Address
string
Email Type
string
Website Address
string
Website Service
string
Website Type
string
Address Street
string
Address City
string
Address State
string
Address Zip
string
Address Country
string
Address Type
string
Tags
string
Comma-separated list of tags.

Returns

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

Create task

This operation is used to create a new task.

Required Parameters

Description
string
Due Date
string
yyyy-MM-dd

Optional Parameters

Due Time
string
hh:mm:ss
Details
string
Id
integer

Returns

task
Task_Response
This operation is used to create a new task.

Delete party

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

Required Parameters

Party Id
string
The id of the party

Returns

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

DeleteOpportunity

This operation is used to delete an existing opportunity.

Required Parameters

Opportunity Id
string
The id of the opportunity

Returns

task
Task_Response
This operation is used to delete an existing opportunity.

Get opportunity

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

Required Parameters

Opportunity Id
string
The id of the opportunity

Returns

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

Get party

This operation retrieves all information about an existing party.

Required Parameters

Party Id
string
The id of the party

Returns

party
Party_Response
This operation retrieves all information about an existing party.

List opportunities

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

Required Parameters

Task Id
string
The id of the task

Returns

opportunities
array of Opportunity_Response
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.

Required Parameters

Task Id
string
The id of the task

Returns

List parties

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

Required Parameters

Task Id
string
The id of the task

Returns

List people

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

Required Parameters

Task Id
string
The id of the task

Returns

List tasks

This operation is used to retrieve a list of tasks.

Required Parameters

Task Id
string
The id of the task

Returns

tasks
array of Task_Response
This operation is used to retrieve a list of tasks.

Update opportunity

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

Required Parameters

Opportunity Id
string
The id of the opportunity
Party Id
integer
Pick a party.
Milestone Id
integer
Pick a milestone.

Optional Parameters

Name
string
Description
string
Duration Basis
string
Duration
string
Expected Close Date
string
yyyy-MM-dd
Winning Probability
integer
Amount
integer
Currency
string

Returns

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

Update organisation

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

Required Parameters

Party Id
string
The id of the party

Optional Parameters

Name
string
About
string
Phone Number
string
Phone Type
string
Email Address
string
Email Type
string
Website Address
string
Website Service
string
Website Type
string
Address Street
string
Address City
string
Address State
string
Address Zip
string
Address Country
string
Address Type
string
Tags
string
Comma-separated list of tags.

Returns

party
Party_Response
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.

Required Parameters

Party Id
string
The id of the party

Optional Parameters

Last Name
string
First Name
string
Title
string
Job Title
string
About
string
Organisation Id
string
Pick an organisation.
Phone Number
string
Phone Type
string
Email Address
string
Email Type
string
Website Address
string
Website Service
string
Website Type
string
Address Street
string
Address City
string
Address State
string
Address Zip
string
Address Country
string
Address Type
string
Tags
string
Comma-separated list of tags.

Returns

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

Triggers

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

Amount the opportunity is worth.
float
amount
Closed Date
string
yyyy-MM-dd
Created Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Currency
string
Currency type of the opportunity.
Description
string
Opportunity description.
Duration
string
Opportunity duration.
Duration Basis
string
Basis for the opportunity duration.
Expected Close Date
string
yyyy-MM-dd
First Name
string
First name when type is person.
Id
integer
Unique id of the party.
Id
integer
Unique id of the user.
Last Name
string
Last name when type is person.
Milestone Id
integer
Unique id of the milestone.
Milestone Name
string
Name of the milestone opportunity is in.
Name
string
Name of the user.
Opportunity Id
integer
Unique id of the opportunity.
Opportunity Name
string
Name of the opportunity.
Picture URL
string
Url that represents the profile picture for this party.
Probability
integer
Probability of winning the opportunity.
Type
string
Person or organization.
Updated Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Username
string
Username of the user.

Listparties_Response

About
string
Organisation description.
Created Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
First Name
string
Person's first name.
Job Title
string
Person's job title.
Last Contacted Date-Time
string
yyyy-MM-ddTHH:mm:ss.fffZ
Last Name
string
Person's last name.
Organisation
string
Person's company.
Organisation Name
string
Name of the organisation.
Party Id
integer
Unique id of the organisation.
Picture URL
string
Url where the image is located.
Title
string
Person's title.
Type
string
Person or organisation.
Updated Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
parties
array of object
party

Party_Response

About
string
Short description about the party.
City
string
Party address.
Country
string
Party address.
Created Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Email Address
string
The actual email address.
Email Type
string
Home or work.
First Name
string
Person's first name.
Job Title
string
Person's job title.
Last Contacted at
string
yyyy-MM-ddTHH:mm:ss.fffZ
Last Name
string
Person's last name.
Organisation
string
Organisation the party is associated with.
Organisation Name
string
Name of the organisation.
Party Id
integer
Unique id of the party.
Phone Number
string
The actual phone number.
Phone Number Type
string
Home, work, mobile, fax, or direct.
Picture URL
string
Url that represents the location of the profile picture for this party.
State
string
Party address.
Street
string
Party address.
Title
string
Person's title.
Type
string
Party address.
Type
string
Person or organisation.
Updated Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Website Address
string
Account username or profile page url.
Website Service
string
Url, skype, twitter, linkedin, facebook, xing, feed, google_plus, flickr, github or youtube.
Website Type
string
Home or work.
Zip
string
Party address.
addresses
array of object
Array of addresses.
emailAddresses
array of object
Array of email addresses.
phoneNumbers
array of object
Phone numbers,
websites
array of object
websites

Task_Response

Colour
string
Description of the task category.
Completed By
string
Username of the person who completed this task.
Completed Date-Time
string
yyyy-MM-ddTHH:mm:ss.fffZ
Created Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Description
string
Short description about the task.
Detail
string
More details about the task.
Due Date
string
yyyy-MM-dd
Due Time
string
hh:mm:ss
First Name
string
First name, if person.
Id
integer
Id of the task category.
Id
integer
Unique id of the party.
Id
integer
Unique id of the user.
Last Name
string
Last name, if person.
Name
string
Name of the user.
Name
string
Name of the task category.
Picture URL
string
Url that represents the location of the profile picture for this party.
Status
string
Open, completed or pending.
Task Id
integer
Unique id of the task.
Type
string
Person or organisation.
Updated Date-Time
date-time
yyyy-MM-ddTHH:mm:ss.fffZ
Username
string
Username of the user.