Connectors Reference
Online CRM for individuals, small businesses and sales teams wanting a simple, effective and affordable solution.
|
Status: Preview |
Tier: Premium |
Version: 1.0.0 |
|
Name |
Summary |
|
List opportunities |
|
|
Create opportunity |
|
|
Get opportunity |
|
|
UpdateOpportunity (string opportunityId, Updateopportunity_Request body) |
Update opportunity |
|
DeleteOpportunity |
|
|
Create person |
|
|
Create person (V2) |
|
|
Update person |
|
|
UpdatePersonV2 (string personId, Updateperson_RequestV2 body) |
Update person (V2) |
|
Create organisation |
|
|
UpdateOrganisation (string id, Updateorganisation_Request body) |
Update organisation |
|
List parties |
|
|
List parties (V2) |
|
|
List people |
|
|
List people (V2) |
|
|
List organizations |
|
|
Get party |
|
|
Delete party |
|
|
Get party (V2) |
|
|
List tasks |
|
|
Create task |
|
|
Complete task |
|
|
List milestones |
|
|
List currencies |
|
Name |
Summary |
|
When an opportunity is created |
|
|
When an opportunity is updated |
|
|
When a task is created |
|
|
When a party is created |
|
|
When a party is created (V2) |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List opportunities
Description: This operation retrieves a list of all opportunities in your Capsule account.
Syntax:
CapsuleCRM.ListOpportunities ()
Returns:
Type:ListOpportunitiesResponse
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 |
|
|
True |
Returns:
Type:CreateOpportunityResponse
Summary: Get opportunity
Description: This operation is used to retrieve all information about an opportunity.
Syntax:
CapsuleCRM.GetOpportunity (string opportunityId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
opportunityId |
string (Opportunity Id) |
The id of the opportunity |
True |
Returns:
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 (Opportunity Id) |
The id of the opportunity |
True |
|
|
body |
|
|
True |
Returns:
Type:UpdateOpportunityResponse
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 (Opportunity Id) |
The id of the opportunity |
True |
Returns:
Type:string
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 |
|
body |
|
|
True |
Returns:
Type:CreatePersonResponse
Summary: Create person (V2)
Description: This operation is used to create a new person in your Capsule account.
Syntax:
CapsuleCRM.CreatePersonV2 (Createperson_RequestV2 body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
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 (Party Id) |
The id of the party |
True |
|
|
body |
|
|
True |
Returns:
Type:UpdatePersonResponse
Summary: Update person (V2)
Description: This operation is used to update the information about an existing person in your Capsule account.
Syntax:
CapsuleCRM.UpdatePersonV2 (string personId, Updateperson_RequestV2 body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
personId |
string (Party Id) |
The id of the party |
True |
|
|
body |
|
|
True |
Returns:
Summary: Create organisation
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 |
|
|
True |
Returns:
Type:CreateOrganisationResponse
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 (Party Id) |
The id of the party |
True |
|
|
body |
|
|
True |
Returns:
Type:UpdateOrganisationResponse
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
Summary: List parties (V2)
Description: This operation is used to retrieve a list of all parties in your Capsule account.
Syntax:
CapsuleCRM.ListPartiesV2 ()
Returns:
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
Summary: List people (V2)
Description: This operation is used to retrieve a list of all people in your Capsule account.
Syntax:
CapsuleCRM.ListPeopleV2 ()
Returns:
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
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 (Party Id) |
The id of the party |
True |
Returns:
Type:GetPartyResponse
Summary: Delete party
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 (Party Id) |
The id of the party |
True |
Returns:
Type:string
Summary: Get party (V2)
Description: This operation retrieves all information about an existing party.
Syntax:
CapsuleCRM.GetPartyV2 (string personId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
personId |
string (Party Id) |
The id of the party |
True |
Returns:
Type:GetPartyV2Response
Summary: List tasks
Description: This operation is used to retrieve a list of tasks.
Syntax:
CapsuleCRM.ListTasks ()
Returns:
Type:ListTasksResponse
Summary: Create task
Description: This operation is used to create a new task.
Syntax:
CapsuleCRM.CreateTask (Createtask_Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:CreateTaskResponse
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 (Task Id) |
The id of the task |
True |
|
|
body |
|
|
True |
Returns:
Type:CompleteTaskResponse
Summary: List milestones
Description: This operation returns a list of milestones.
Syntax:
CapsuleCRM.ListMilestones ()
Returns:
Summary: List currencies
Description: This operation returns a list of currencies.
Syntax:
CapsuleCRM.ListCurrencies ()
Returns:
Summary: When an opportunity is created
Description: This operation triggers when a new opportunity is created in your account.
Syntax:
CapsuleCRM.OnNewOpportunity ()
Returns:
Type:array of (Opportunity_Response)
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)
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)
Summary: When a party is created
Description: This operation triggers when a new party is created in your account.
Syntax:
CapsuleCRM.OnNewParty ()
Returns:
Type:array of (Party_Response)
Summary: When a party is created (V2)
Description: This operation triggers when a new party is created in your account.
Syntax:
CapsuleCRM.OnNewPartyV2 ()
Returns:
Type:array of (Party_ResponseV2)
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
task |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
task |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string Status |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
opportunity |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
opportunity |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Name |
|
|
party |
Party |
|
|
milestone |
Milestone |
|
|
description |
string Description |
|
|
durationBasis |
string Duration Basis |
Values: [FIXED, HOUR, DAY, MONTH, YEAR, WEEK, QUARTER] |
|
duration |
string Duration |
|
|
expectedCloseOn |
string Expected Close Date |
yyyy-MM-dd |
|
probability |
integer(int32) Winning Probability |
|
|
value |
Expected |
Expected value |
Summary: Party
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Party Id |
Pick a party. |
Summary: Milestone
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Id |
Pick a milestone. |
Summary: Expected
Description: Expected value
Properties:
|
Name |
Type |
Summary |
|
amount |
integer(int32) Amount |
|
|
currency |
string Currency |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
party |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
party |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Name |
|
|
about |
string About |
|
|
phoneNumbers |
|
|
|
emailAddresses |
|
|
|
websites |
|
|
|
addresses |
|
|
|
tags |
string Tags |
Comma-separated list of tags. |
|
type |
string Type |
Organisation type. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
number |
string Phone Number |
|
|
type |
string Phone Type |
Values: [Home, Work, Mobile, Fax, Direct] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string Email Address |
|
|
type |
string Email Type |
Values: [Home, Work] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string Website Address |
|
|
service |
string Website Service |
Values: [FEED, FACEBOOK, FLICKR, GITHUB, GOOGLE_PLUS, INSTAGRAM, LINKED_IN, PINTEREST, SKYPE, TWITTER, URL, XING, YOUTUBE] |
|
type |
string Website Type |
Values: [Home, Work] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
street |
string Address Street |
|
|
city |
string Address City |
|
|
state |
string Address State |
|
|
zip |
string Address Zip |
|
|
country |
string Address Country |
|
|
type |
string Address Type |
Values: [Home, Postal, Office] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
party |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
party |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
party |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
lastName |
string Last Name |
|
|
firstName |
string First Name |
|
|
title |
string Title |
Values: [Mr, Master, Mrs, Miss, Ms, Dr, Prof] |
|
jobTitle |
string Job Title |
|
|
about |
string About |
|
|
organisation |
string Organisation Id |
Pick an organisation. |
|
phoneNumbers |
|
|
|
emailAddresses |
|
|
|
websites |
|
|
|
addresses |
|
|
|
tags |
string Tags |
Comma-separated list of tags. |
|
type |
string Type |
Party type. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
number |
string Phone Number |
|
|
type |
string Phone Type |
Values: [Home, Work, Mobile, Fax, Direct] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string Email Address |
|
|
type |
string Email Type |
Values: [Home, Work] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string Website Address |
|
|
service |
string Website Service |
Values: [FEED, FACEBOOK, FLICKR, GITHUB, GOOGLE_PLUS, INSTAGRAM, LINKED_IN, PINTEREST, SKYPE, TWITTER, URL, XING, YOUTUBE] |
|
type |
string Website Type |
Values: [Home, Work] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
street |
string Address Street |
|
|
city |
string Address City |
|
|
state |
string Address State |
|
|
zip |
string Address Zip |
|
|
country |
string Address Country |
|
|
type |
string Address Type |
Values: [Home, Postal, Office] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
party |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
lastName |
string Last Name |
|
|
firstName |
string First Name |
|
|
title |
string Title |
Values: [Mr, Master, Mrs, Miss, Ms, Dr, Prof] |
|
jobTitle |
string Job Title |
|
|
about |
string About |
|
|
organisation |
Organisation |
|
|
phoneNumbers |
|
|
|
emailAddresses |
|
|
|
websites |
|
|
|
addresses |
|
|
|
tags |
string Tags |
Comma-separated list of tags. |
|
type |
string Type |
Party type. |
Summary: Organisation
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Id |
Pick an organisation. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
number |
string Phone Number |
|
|
type |
string Phone Type |
Values: [Home, Work, Mobile, Fax, Direct] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string Email Address |
|
|
type |
string Email Type |
Values: [Home, Work] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string Website Address |
|
|
service |
string Website Service |
Values: [FEED, FACEBOOK, FLICKR, GITHUB, GOOGLE_PLUS, INSTAGRAM, LINKED_IN, PINTEREST, SKYPE, TWITTER, URL, XING, YOUTUBE] |
|
type |
string Website Type |
Values: [Home, Work] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
street |
string Address Street |
|
|
city |
string Address City |
|
|
state |
string Address State |
|
|
zip |
string Address Zip |
|
|
country |
string Address Country |
|
|
type |
string Address Type |
Values: [Home, Postal, Office] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
task |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
task |
|
task |
Summary:
Description: task
Properties:
|
Name |
Type |
Summary |
|
description |
string Description |
|
|
dueOn |
string Due Date |
yyyy-MM-dd |
|
dueTime |
string Due Time |
hh:mm:ss |
|
detail |
string Details |
|
|
party |
Party |
|
Summary: Party
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Id |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
opportunity |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
party |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
party |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
currencies |
array of (CurrenciesItem) currencies |
currencies |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
code |
string Currency Code |
code |
|
name |
string Currency Name |
name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
milestones |
array of (MilestonesItem)
|
milestones |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
complete |
boolean Is Complete |
True if the milestone is complete. |
|
createdAt |
string(date-time) Create Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
description |
string Description |
Milestone description. |
|
id |
integer(int32) Milestone Id |
Unique id of the milestone. |
|
name |
string Milestone Name |
Name of the milestone. |
|
probability |
integer(int32) Probability |
Percent probability of winning. |
|
updatedAt |
string(date-time) Updated Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
opportunities |
array of (Opportunity_Response)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
parties |
array of (PartiesItem)
|
party |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Organisation Name |
Name of the organisation. |
|
about |
string About |
Organisation description. |
|
createdAt |
string(date-time) Created Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
firstName |
string First Name |
Person's first name. |
|
id |
integer(int32) Party Id |
Unique id of the organisation. |
|
jobTitle |
string Job Title |
Person's job title. |
|
lastContactedAt |
string Last Contacted Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
lastName |
string Last Name |
Person's last name. |
|
organisation |
string Organisation |
Person's company. |
|
pictureURL |
string Picture URL |
Url where the image is located. |
|
title |
string Title |
Person's title. |
|
type |
string Type |
Person or organisation. |
|
updatedAt |
string(date-time) Updated Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
parties |
array of (PartiesItem)
|
party |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Organisation Name |
Name of the organisation. |
|
about |
string About |
Party description. |
|
createdAt |
string(date-time) Created Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
firstName |
string First Name |
Person's first name. |
|
id |
integer(int32) Party Id |
Unique id of the party. |
|
jobTitle |
string Job Title |
Person's job title. |
|
lastContactedAt |
string Last Contacted Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
lastName |
string Last Name |
Person's last name. |
|
organisation |
Nested Organisation |
Organisation the party is associated with. |
|
pictureURL |
string Picture URL |
Url where the image is located. |
|
title |
string Title |
Person's title. |
|
type |
string Type |
Person or organisation. |
|
updatedAt |
string(date-time) Updated Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
Summary: Nested Organisation
Description: Organisation the party is associated with.
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Id |
The unique id of the organisation. |
|
name |
string Name |
The name of the organisation. |
|
pictureURL |
string Picture URL |
Url that represents the location of the profile picture for this party. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
tasks |
array of (Task_Response)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
closedOn |
string Closed Date |
yyyy-MM-dd |
|
createdAt |
string(date-time) Created Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
description |
string Description |
Opportunity description. |
|
duration |
integer Duration |
Opportunity duration. |
|
durationBasis |
string Duration Basis |
Basis for the opportunity duration. |
|
expectedCloseOn |
string Expected Close Date |
yyyy-MM-dd |
|
id |
integer(int32) Opportunity Id |
Unique id of the opportunity. |
|
milestone |
|
Milestone object. |
|
name |
string Opportunity Name |
Name of the opportunity. |
|
owner |
Owner |
Represents a reference to the user object. |
|
party |
Party |
Represents a contact object. |
|
probability |
integer(int32) Probability |
Probability of winning the opportunity. |
|
updatedAt |
string(date-time) Updated Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
value |
Value |
Opportunity value object. |
Summary:
Description: Milestone object.
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Milestone Id |
Unique id of the milestone. |
|
name |
string Milestone Name |
Name of the milestone opportunity is in. |
Summary: Owner
Description: Represents a reference to the user object.
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Id |
Unique id of the user. |
|
name |
string Name |
Name of the user. |
|
username |
string Username |
Username of the user. |
Summary: Party
Description: Represents a contact object.
Properties:
|
Name |
Type |
Summary |
|
firstName |
string First Name |
First name when type is person. |
|
id |
integer(int32) Id |
Unique id of the party. |
|
lastName |
string Last Name |
Last name when type is person. |
|
pictureURL |
string Picture URL |
Url that represents the profile picture for this party. |
|
type |
string Type |
Person or organization. |
Summary: Value
Description: Opportunity value object.
Properties:
|
Name |
Type |
Summary |
|
amount |
number(float) Amount the opportunity is worth. |
amount |
|
currency |
string Currency |
Currency type of the opportunity. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Organisation Name |
Name of the organisation. |
|
about |
string About |
Short description about the party. |
|
addresses |
array of (AddressesItem)
|
Array of addresses. |
|
createdAt |
string(date-time) Created Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
emailAddresses |
array of (EmailAddressesItem)
|
Array of email addresses. |
|
firstName |
string First Name |
Person's first name. |
|
id |
integer(int32) Party Id |
Unique id of the party. |
|
jobTitle |
string Job Title |
Person's job title. |
|
lastContactedAt |
string Last Contacted at |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
lastName |
string Last Name |
Person's last name. |
|
organisation |
string Organisation |
Organisation the party is associated with. |
|
phoneNumbers |
array of (PhoneNumbersItem)
|
Phone numbers, |
|
pictureURL |
string Picture URL |
Url that represents the location of the profile picture for this party. |
|
title |
string Title |
Person's title. |
|
type |
string Type |
Person or organisation. |
|
updatedAt |
string(date-time) Updated Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
websites |
array of (WebsitesItem)
|
websites |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
city |
string City |
Party address. |
|
country |
string Country |
Party address. |
|
state |
string State |
Party address. |
|
street |
string Street |
Party address. |
|
type |
string Type |
Party address. |
|
zip |
string Zip |
Party address. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string Email Address |
The actual email address. |
|
type |
string Email Type |
Home or work. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
number |
string Phone Number |
The actual phone number. |
|
type |
string Phone Number Type |
Home, work, mobile, fax, or direct. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string Website Address |
Account username or profile page url. |
|
service |
string Website Service |
Url, skype, twitter, linkedin, facebook, xing, feed, google_plus, flickr, github or youtube. |
|
type |
string Website Type |
Home or work. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Organisation Name |
Name of the organisation. |
|
about |
string About |
Short description about the party. |
|
addresses |
array of (AddressesItem)
|
Array of addresses. |
|
createdAt |
string(date-time) Created Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
emailAddresses |
array of (EmailAddressesItem)
|
Array of email addresses. |
|
firstName |
string First Name |
Person's first name. |
|
id |
integer(int32) Party Id |
Unique id of the party. |
|
jobTitle |
string Job Title |
Person's job title. |
|
lastContactedAt |
string Last Contacted at |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
lastName |
string Last Name |
Person's last name. |
|
organisation |
Nested Organisation |
Organisation the party is associated with. |
|
phoneNumbers |
array of (PhoneNumbersItem)
|
Phone numbers, |
|
pictureURL |
string Picture URL |
Url that represents the location of the profile picture for this party. |
|
title |
string Title |
Person's title. |
|
type |
string Type |
Person or organisation. |
|
updatedAt |
string(date-time) Updated Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
websites |
array of (WebsitesItem)
|
websites |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
city |
string City |
Party address. |
|
country |
string Country |
Party address. |
|
state |
string State |
Party address. |
|
street |
string Street |
Party address. |
|
type |
string Type |
Party address. |
|
zip |
string Zip |
Party address. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string Email Address |
The actual email address. |
|
type |
string Email Type |
Home or work. |
Summary: Nested Organisation
Description: Organisation the party is associated with.
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Id |
The unique id of the organisation. |
|
name |
string Name |
The name of the organisation. |
|
pictureURL |
string Picture URL |
Url that represents the location of the profile picture for this party. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
number |
string Phone Number |
The actual phone number. |
|
type |
string Phone Number Type |
Home, work, mobile, fax, or direct. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string Website Address |
Account username or profile page url. |
|
service |
string Website Service |
Url, skype, twitter, linkedin, facebook, xing, feed, google_plus, flickr, github or youtube. |
|
type |
string Website Type |
Home or work. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
category |
Category |
category |
|
completedAt |
string Completed Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
completedBy |
string Completed By |
Username of the person who completed this task. |
|
createdAt |
string(date-time) Created Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
description |
string Description |
Short description about the task. |
|
detail |
string Detail |
More details about the task. |
|
dueOn |
string Due Date |
yyyy-MM-dd |
|
dueTime |
string Due Time |
hh:mm:ss |
|
id |
integer(int32) Task Id |
Unique id of the task. |
|
owner |
Owner |
User the task is assigned to. |
|
party |
Party |
Represents a person or organisation in Capsule. |
|
status |
string Status |
Open, completed or pending. |
|
updatedAt |
string(date-time) Updated Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
Summary: Category
Description: category
Properties:
|
Name |
Type |
Summary |
|
colour |
string Colour |
Description of the task category. |
|
id |
integer(int32) Id |
Id of the task category. |
|
name |
string Name |
Name of the task category. |
Summary: Owner
Description: User the task is assigned to.
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Id |
Unique id of the user. |
|
name |
string Name |
Name of the user. |
|
username |
string Username |
Username of the user. |
Summary: Party
Description: Represents a person or organisation in Capsule.
Properties:
|
Name |
Type |
Summary |
|
firstName |
string First Name |
First name, if person. |
|
id |
integer(int32) Id |
Unique id of the party. |
|
lastName |
string Last Name |
Last name, if person. |
|
pictureURL |
string Picture URL |
Url that represents the location of the profile picture for this party. |
|
type |
string Type |
Person or organisation. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
opportunity |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
opportunity |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Name |
|
|
party |
Party |
|
|
milestone |
Milestone |
|
|
description |
string Description |
|
|
durationBasis |
string Duration Basis |
Values: [FIXED, HOUR, DAY, MONTH, YEAR, WEEK, QUARTER] |
|
duration |
string Duration |
|
|
expectedCloseOn |
string Expected Close Date |
yyyy-MM-dd |
|
probability |
integer(int32) Winning Probability |
|
|
value |
Expected |
Expected value |
Summary: Party
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Party Id |
Pick a party. |
Summary: Milestone
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Milestone Id |
Pick a milestone. |
Summary: Expected
Description: Expected value
Properties:
|
Name |
Type |
Summary |
|
amount |
integer(int32) Amount |
|
|
currency |
string Currency |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
party |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
party |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Name |
|
|
about |
string About |
|
|
phoneNumbers |
|
|
|
emailAddresses |
|
|
|
websites |
|
|
|
addresses |
|
|
|
tags |
string Tags |
Comma-separated list of tags. |
|
type |
string Type |
Organisation type. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
number |
string Phone Number |
|
|
type |
string Phone Type |
Values: [Home, Work, Mobile, Fax, Direct] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string Email Address |
|
|
type |
string Email Type |
Values: [Home, Work] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string Website Address |
|
|
service |
string Website Service |
Values: [FEED, FACEBOOK, FLICKR, GITHUB, GOOGLE_PLUS, INSTAGRAM, LINKED_IN, PINTEREST, SKYPE, TWITTER, URL, XING, YOUTUBE] |
|
type |
string Website Type |
Values: [Home, Work] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
street |
string Address Street |
|
|
city |
string Address City |
|
|
state |
string Address State |
|
|
zip |
string Address Zip |
|
|
country |
string Address Country |
|
|
type |
string Address Type |
Values: [Home, Postal, Office] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
party |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
party |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
party |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
lastName |
string Last Name |
|
|
firstName |
string First Name |
|
|
title |
string Title |
Values: [Mr, Master, Mrs, Miss, Ms, Dr, Prof] |
|
jobTitle |
string Job Title |
|
|
about |
string About |
|
|
organisation |
string Organisation Id |
Pick an organisation. |
|
phoneNumbers |
|
|
|
emailAddresses |
|
|
|
websites |
|
|
|
addresses |
|
|
|
tags |
string Tags |
Comma-separated list of tags. |
|
type |
string Type |
Party type. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
number |
string Phone Number |
|
|
type |
string Phone Type |
Values: [Home, Work, Mobile, Fax, Direct] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string Email Address |
|
|
type |
string Email Type |
Values: [Home, Work] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string Website Address |
|
|
service |
string Website Service |
Values: [FEED, FACEBOOK, FLICKR, GITHUB, GOOGLE_PLUS, INSTAGRAM, LINKED_IN, PINTEREST, SKYPE, TWITTER, URL, XING, YOUTUBE] |
|
type |
string Website Type |
Values: [Home, Work] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
street |
string Address Street |
|
|
city |
string Address City |
|
|
state |
string Address State |
|
|
zip |
string Address Zip |
|
|
country |
string Address Country |
|
|
type |
string Address Type |
Values: [Home, Postal, Office] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
party |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
lastName |
string Last Name |
|
|
firstName |
string First Name |
|
|
title |
string Title |
Values: [Mr, Master, Mrs, Miss, Ms, Dr, Prof] |
|
jobTitle |
string Job Title |
|
|
about |
string About |
|
|
organisation |
Organisation |
|
|
phoneNumbers |
|
|
|
emailAddresses |
|
|
|
websites |
|
|
|
addresses |
|
|
|
tags |
string Tags |
Comma-separated list of tags. |
|
type |
string Type |
Party type. |
Summary: Organisation
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Id |
Pick an organisation. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
number |
string Phone Number |
|
|
type |
string Phone Type |
Values: [Home, Work, Mobile, Fax, Direct] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string Email Address |
|
|
type |
string Email Type |
Values: [Home, Work] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string Website Address |
|
|
service |
string Website Service |
Values: [FEED, FACEBOOK, FLICKR, GITHUB, GOOGLE_PLUS, INSTAGRAM, LINKED_IN, PINTEREST, SKYPE, TWITTER, URL, XING, YOUTUBE] |
|
type |
string Website Type |
Values: [Home, Work] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
street |
string Address Street |
|
|
city |
string Address City |
|
|
state |
string Address State |
|
|
zip |
string Address Zip |
|
|
country |
string Address Country |
|
|
type |
string Address Type |
Values: [Home, Postal, Office] |