Connectors Reference

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 (Createopportunity_Request body)

Create opportunity

GetOpportunity (string opportunityId)

Get opportunity

UpdateOpportunity (string opportunityId, Updateopportunity_Request body)

Update opportunity

DeleteOpportunity (string opportunityId)

DeleteOpportunity

CreatePerson (Createperson_Request body)

Create person

UpdatePerson (string personId, Updateperson_Request body)

Update person

CreateOrganisation (Createorganisation_Request body)

Create organisation

UpdateOrganisation (string id, Updateorganisation_Request body)

Update organisation

ListParties ()

List parties

ListPeople ()

List people

ListOrganizations ()

List organizations

GetParty (string personId)

Get party

DeleteParty (string personId)

Delete party

ListTasks ()

List tasks

CreateTask (Createtask_Request body)

Create task

CompleteTask (string taskId, Completetask_Request body)

Complete task

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

 

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.

 

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)

 

Parameters:

Name

Type

Summary

Required

Related Action

opportunityId

string

(Opportunity Id)

The id of the opportunity

True

 

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

(Opportunity Id)

The id of the opportunity

True

body

Updateopportunity_Request

 

 

True

 

Returns:

          Type:UpdateOpportunityResponse

 

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

(Opportunity Id)

The id of the opportunity

True

 

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

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

(Party Id)

The id of the party

True

body

Updateperson_Request

 

 

True

 

Returns:

          Type:UpdatePersonResponse

 

CreateOrganisation

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

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

(Party Id)

The id of the party

True

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

 

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

(Party Id)

The id of the party

True

 

Returns:

          Type:GetPartyResponse

 

DeleteParty

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

 

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:

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

(Task Id)

The id of the task

True

body

Completetask_Request

 

 

True

 

Returns:

          Type:CompleteTaskResponse

 

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:

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.

 

Syntax:

CapsuleCRM.OnNewParty ()

 

Returns:

          Type:array of (Party_Response)

 


 

CompleteTaskResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

task

Task_Response

 

 


 

Completetask_Request

Summary:

Description:

 

          Properties:

Name

Type

Summary

task

Task

 

 

 

Task

Summary:

Description:

 

          Properties:

Name

Type

Summary

status

string

Status

 

 


 

CreateOpportunityResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

opportunity

Opportunity_Response

 

 


 

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

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

Value

Expected

Expected value

 

Party

Summary: Party

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Party Id

Pick a party.

 

Milestone

Summary: Milestone

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Id

Pick a milestone.

 

Value

Summary: Expected

Description: Expected value

 

          Properties:

Name

Type

Summary

amount

integer(int32)

Amount

 

currency

string

Currency

 

 


 

CreateOrganisationResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

party

Party_Response

 

 


 

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

Tags

Comma-separated list of tags.

type

string

Type

Organisation type.

 

PhoneNumbers

Summary:

Description:

 

          Properties:

Name

Type

Summary

number

string

Phone Number

 

type

string

Phone Type

Values: [Home, Work, Mobile, Fax, Direct]

 

EmailAddresses

Summary:

Description:

 

          Properties:

Name

Type

Summary

address

string

Email Address

 

type

string

Email Type

Values: [Home, Work]

 

Websites

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]

 

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

Address Country

 

type

string

Address Type

Values: [Home, Postal, Office]

 


 

CreatePersonResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

party

Party_Response

 

 


 

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

Title

Values: [Mr, Master, Mrs, Miss, Ms, Dr, Prof]

jobTitle

string

Job Title

 

about

string

About

 

organisation

string

Organisation Id

Pick an organisation.

phoneNumbers

PhoneNumbers

 

 

emailAddresses

EmailAddresses

 

 

websites

Websites

 

 

addresses

Addresses

 

 

tags

string

Tags

Comma-separated list of tags.

type

string

Type

Party type.

 

PhoneNumbers

Summary:

Description:

 

          Properties:

Name

Type

Summary

number

string

Phone Number

 

type

string

Phone Type

Values: [Home, Work, Mobile, Fax, Direct]

 

EmailAddresses

Summary:

Description:

 

          Properties:

Name

Type

Summary

address

string

Email Address

 

type

string

Email Type

Values: [Home, Work]

 

Websites

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]

 

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

Address Country

 

type

string

Address Type

Values: [Home, Postal, Office]

 


 

CreateTaskResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

task

Task_Response

 

 


 

Createtask_Request

Summary:

Description:

 

          Properties:

Name

Type

Summary

task

Task

 

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

Party

 

 

Party

Summary: Party

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Id

 

 


 

GetOpportunityResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

opportunity

Opportunity_Response

 

 


 

GetPartyResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

party

Party_Response

 

 


 

Listcurrencies_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

currencies

array of (CurrenciesItem)

currencies

currencies

 

CurrenciesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

code

string

Currency Code

code

name

string

Currency Name

name

 


 

Listmilestones_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

milestones

array of (MilestonesItem)

 

milestones

 

MilestonesItem

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

 


 

ListOpportunitiesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

opportunities

array of (Opportunity_Response)

 

 


 

Listparties_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

parties

array of (PartiesItem)

 

party

 

PartiesItem

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

 


 

ListTasksResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

tasks

array of (Task_Response)

 

 


 

Opportunity_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

string

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

 

Milestone object.

name

string

Opportunity Name

Name of the opportunity.

owner

Owner

Owner

Represents a reference to the user object.

party

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

Value

Opportunity value object.

 

Milestone

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.

 

Owner

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.

 

Party

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.

 

Value

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.

 


 

Party_Response

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

 

AddressesItem

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.

 

EmailAddressesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

address

string

Email Address

The actual email address.

type

string

Email Type

Home or work.

 

PhoneNumbersItem

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.

 

WebsitesItem

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.

 


 

Task_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

category

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

Owner

User the task is assigned to.

party

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

 

Category

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.

 

Owner

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.

 

Party

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.

 


 

UpdateOpportunityResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

opportunity

Opportunity_Response

 

 


 

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

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

Value

Expected

Expected value

 

Party

Summary: Party

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Party Id

Pick a party.

 

Milestone

Summary: Milestone

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Milestone Id

Pick a milestone.

 

Value

Summary: Expected

Description: Expected value

 

          Properties:

Name

Type

Summary

amount

integer(int32)

Amount

 

currency

string

Currency

 

 


 

UpdateOrganisationResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

party

Party_Response

 

 


 

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

Tags

Comma-separated list of tags.

type

string

Type

Organisation type.

 

PhoneNumbers

Summary:

Description:

 

          Properties:

Name

Type

Summary

number

string

Phone Number

 

type

string

Phone Type

Values: [Home, Work, Mobile, Fax, Direct]

 

EmailAddresses

Summary:

Description:

 

          Properties:

Name

Type

Summary

address

string

Email Address

 

type

string

Email Type

Values: [Home, Work]

 

Websites

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]

 

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

Address Country

 

type

string

Address Type

Values: [Home, Postal, Office]

 


 

UpdatePersonResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

party

Party_Response

 

 


 

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

Title

Values: [Mr, Master, Mrs, Miss, Ms, Dr, Prof]

jobTitle

string

Job Title

 

about

string

About

 

organisation

string

Organisation Id

Pick an organisation.

phoneNumbers

PhoneNumbers

 

 

emailAddresses

EmailAddresses

 

 

websites

Websites

 

 

addresses

Addresses

 

 

tags

string

Tags

Comma-separated list of tags.

type

string

Type

Party type.

 

PhoneNumbers

Summary:

Description:

 

          Properties:

Name

Type

Summary

number

string

Phone Number

 

type

string

Phone Type

Values: [Home, Work, Mobile, Fax, Direct]

 

EmailAddresses

Summary:

Description:

 

          Properties:

Name

Type

Summary

address

string

Email Address

 

type

string

Email Type

Values: [Home, Work]

 

Websites

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]

 

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

Address Country

 

type

string

Address Type

Values: [Home, Postal, Office]