Connectors Reference

Outlook Customer Manager

Outlook Customer Manager helps small businesses track and grow customer relationships from right within Outlook. It is included at no extra cost in Office 365 Business Premium subscription.

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

CreateContact (CreateContactParameterBody body, [internal]string Content-Type, [internal]string X-XRM-Client)

Create a business contact

CreateCompany (CreateCompanyParameterBody body, [internal]string Content-Type, [internal]string X-XRM-Client)

Create a company

CreateDeal (CreateDealParameterBody body, [internal]string Content-Type, [internal]string X-XRM-Client)

Create a deal

CreateActivity (CreateActivityParameterBody body, [internal]string Content-Type, [internal]string X-XRM-Client)

Create an activity

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

CreateActivityParameterBody

 

CreateActivityResponse

 

CreateCompanyParameterBody

 

CreateCompanyResponse

 

CreateContactParameterBody

 

CreateContactResponse

 

CreateDealParameterBody

 

CreateDealResponse

 

 

Actions:

CreateContact

Summary: Create a business contact

Description: This operation is used to create a business contact in Outlook Customer Manager.

 

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

(Content-Type)

 

True

X-XRM-Client

string

(X-XRM-Client)

 

True

 

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

(Content-Type)

 

True

X-XRM-Client

string

(X-XRM-Client)

 

True

 

Returns:

          Type:CreateCompanyResponse

 

CreateDeal

Summary: Create a deal

Description: This operation is used to create a deal in Outlook Customer Manager.

 

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

(Content-Type)

 

True

X-XRM-Client

string

(X-XRM-Client)

 

True

 

Returns:

          Type:CreateDealResponse

 

CreateActivity

Summary: Create an activity

Description: This operation is used to create an activity on the timeline of a contact, company or deal in Outlook Customer Manger.

 

Syntax:

OutlookCustomerManager.CreateActivity (CreateActivityParameterBody body, [internal]string Content-Type, [internal]string X-XRM-Client)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateActivityParameterBody

 

 

True

Content-Type

string

(Content-Type)

 

True

X-XRM-Client

string

(X-XRM-Client)

 

True

 

Returns:

          Type:CreateActivityResponse

 


 

CreateActivityParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

Data

 

data

iconColor

string

Color of Initials

Define the colors in which the initials should be displayed on the timeline.  Values: [Black, Blue, Green, Orange, Magenta, Purple, Red, Teal, Yellow]

iconInitials

string

Initials

Add the initials used in the activity timeline. Maximum 2 characters are allowed.

line1Text

string

Text for first line

Add the text for the first line of the activity in the activity timeline

line2Text

string

Text for second line

Add the text for the second line of the activity in the activity timeline

linkToEntityType

string

Link to

Choose if the activity is linked to a contact, company or deal.  Values: [Contact, Company, Deal]

linkToDisplayName

string

Linked contact, company or deal

Add the name of the  contact, company or deal the activity timeline should show up.

linkToEmailAddress

string

Linked contact email address

When selecting a contact, also add the email address for more accurate results.

source

string

Source

Add the source the activity is coming from.

url

string

Url

Add a url to be opened when clicking on the activity.

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

actionVerb

string

Activity type

Specify, which type of activity will be created. Has to be "Post"

eventTime

string(date-time)

Activity Date and Time

Add an activity date-time in UTC format- eg. 2017-04-23T18:30:00Z

subtype

string

Activity category

Specify the category of the Activity type. Has to be "Apps".

 


 

CreateActivityResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

result

Result

 

result

 

Result

Summary:

Description: result

 

          Properties:

Name

Type

Summary

eventTime

string(date-time)

eventTime

eventTime

linkedEntityNames

string

Linked to

This activity has been linked to

 


 

CreateCompanyParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

Data

 

data

contactDisplayName

string

Contact Name

Linked contact details.

contactEmailAddress

string

Contact Email Address

Linked contact details.

shouldShare

boolean

Share

Specify if the company should be shared. Has to be false (for now).

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

displayName

string

Name

Add company name

businessHomePage

string

Website

Add a website

emailAddresses

array of (EmailAddressesItem)

 

 

businessPhones

array of (string)

 

 

businessAddress

BusinessAddress

Address -

Add a business address

entityType

string

Entity

Specify the entity, needs to be "Company".

 

EmailAddressesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

address

string

Email Address

Add an Email address

name

string

Name

Add name of the email address.

 

BusinessAddress

Summary: Address -

Description: Add a business address

 

          Properties:

Name

Type

Summary

city

string

City

Add a city

countryOrRegion

string

Country or Region

Add a country or Region

postalCode

string

Zip Code

Add zip

state

string

State

Add a state

street

string

Street

Add a street

type

integer(int32)

Type

This value has to be 1.

 


 

CreateCompanyResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

result

Result

 

result

 

Result

Summary:

Description: result

 

          Properties:

Name

Type

Summary

displayName

string

Company Name

Name of the company.

businessHomePage

string

Website

Company's website.

emailAddresses

array of (EmailAddressesItem)

 

 

businessPhones

array of (string)

 

 

businessAddress

BusinessAddress

 

 

 

EmailAddressesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

address

string

Email Address

Company's email address.

 

BusinessAddress

Summary:

Description:

 

          Properties:

Name

Type

Summary

city

string

City

Business address of the company.

countryOrRegion

string

Country or Region

Business address of the company.

postalCode

string

Zip Code

Business address of the company.

state

string

State

Business address of the company.

street

string

Street

Business address of the company.

 


 

CreateContactParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

Data

 

data

companyDisplayName

string

Company

Add company

shouldShare

boolean

Share

Specify if the contact will be shared. Has to be false (for now).

 

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

Entity

Specify the entity, has to be "Persona".

isBusinessContact

boolean

Business contact

Specify if this is a business contact or not - needs to be true.

 

EmailAddressesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

address

string

Email Address

Add an email address

name

string

Name

Add name for the email address.

 


 

CreateContactResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

result

Result

 

result

 

Result

Summary:

Description: result

 

          Properties:

Name

Type

Summary

displayName

string

Name

Business contact's name.

emailAddresses

array of (EmailAddressesItem)

 

 

givenNames

array of (string)

 

 

surnames

array of (string)

 

 

businessPhoneNumbers

array of (string)

 

 

 

EmailAddressesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

address

string

Email Address

Business contact's email.

 


 

CreateDealParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

Data

 

data

contactDisplayName

string

Contact Name

Details of the linked contact.

contactEmailAddress

string

Contact Email

Details of the linked contact.

companyDisplayName

string

Linked Company

Name of the linked company.

shouldShare

boolean

Share

Specify, if this deal is shared or not. Has to be false (for now).

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

name

string

Name

Add a name

amount

integer(int32)

Amount

Add amount

closeTime

string(date-time)

Close Date

MM/DD/YYYY or UTC format

entityType

string

Entity

Specify the entity type, has to be "Deal".

priority

string

Priority

Pick a priority.  Values: [Normal, High]

stage

string

Stage

Pick a stage.  Values: [In-progress, Won, Lost, Invalid]

 


 

CreateDealResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

result

Result

 

result

 

Result

Summary:

Description: result

 

          Properties:

Name

Type

Summary

name

string

Name

Deal's name.

amount

number(float)

Amount

Deal's amount.

closeTime

string(date-time)

Close Date

Deal's close date.

priority

string

Priority

Normal or high.

stage

string

Stage

In-progress, won, lost or invalid.

company

string

Company

Related company.