Contoso Hub

  • Reference

This is a sample connector to extend Copilot for Sales

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
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Connector Metadata
Publisher Microsoft

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Chat about key stakeholders (Preview)

This API returns the key decision makers, or key stackholders for an account, given a CRM account name as input
Enrich CRM record details (Preview)

This action gets records related to a CRM record. The action enhances the existing skills of Copilot for Sales
Enrich CRM record summary (Preview)

This action gets additional sales insights related to a CRM record that will be shown in the C4S record summary card. The action enhances the existing skills of copilot for sales
Enrich email summary (Preview)

This action gets additional sales insights that will be shown in C4S email summary experience inside outlook summary. The action enhances the existing skills of copilot for sales
Enrich key sales info (Preview)

This action gets additional sales insights that will be shown in C4S key sales info card in outlook sidecar. The action enhances the existing skills of Copilot for sales

Chat about key stakeholders (Preview)

Operation ID:
scp-get-key-stakeholders

This API returns the key decision makers, or key stackholders for an account, given a CRM account name as input

Parameters

Name Key Required Type Description
accountName
 accountName True string

The input CRM account name
crmType
 crmType string

This input indicates the type of CRM in which the CRM acount exists, for which key decision makers, or key stackholders is requested

Returns

Body
PartnerConnectorResponse

Enrich CRM record details (Preview)

Operation ID:
scp-get-related-records

This action gets records related to a CRM record. The action enhances the existing skills of Copilot for Sales

Parameters

Name Key Required Type Description
recordType
 recordType True string

This input identifies the record type in CRM for which related records are requested
recordId
 recordId True string

This input provides the unique identifier of the CRM record for which related records are requested
top
 top integer

This input indicates the number of related records to fetch
skip
 skip integer

This input indicates the number of records to skip when fetching related records
crmType
 crmType string

This input indicates the type of CRM the related records are fetched from
crmOrgUrl
 crmOrgUrl string

This input indicates the URL of the CRM environment the related records are fetched from

Returns

Body
ExternalRelatedRecordListResponseEnvelope

Enrich CRM record summary (Preview)

Operation ID:
scp-get-related-activities

This action gets additional sales insights related to a CRM record that will be shown in the C4S record summary card. The action enhances the existing skills of copilot for sales

Parameters

Name Key Required Type Description
recordType
 recordType True string

This input indicates the entity or object type in CRM for which insights are requested
recordId
 recordId True string

This input indicates the unique identifier of the CRM record for which insights are requested
startDateTime
 startDateTime date-time

This input indicates the start date and time for insights requested
endDateTime
 endDateTime date-time

This input indicates the end date and time for insights requested
top
 top integer

This input indicates the number of insights to fetch
skip
 skip integer

This input indicates the number of insights to skip
crmType
 crmType string

This input indicates the type of CRM in which the CRM record exists, for which insights are requested
crmOrgUrl
 crmOrgUrl string

This input indicates the URL of the CRM environment in which the CRM record exists, for which insights are requested.

Returns

Body
ActivityListResponseEnvelope

Enrich email summary (Preview)

Operation ID:
scp-get-email-insights

This action gets additional sales insights that will be shown in C4S email summary experience inside outlook summary. The action enhances the existing skills of copilot for sales

Parameters

Name Key Required Type Description
emailContacts
 emailContacts True string

This input indicates a list of all relevant participant emails in the current email thread
recordType
 recordType string

This input identifies the record type in CRM which is related to the summarized email
recordId
 recordId string

This input provides the unique identifier of the CRM record which is related to the summarized email
crmType
 crmType string

This input indicates the type of CRM in which the record related to the summarized email exists
crmOrgUrl
 crmOrgUrl string

This input indicates the URL of the CRM environment in which the record related to the summarized email exists
top
 top integer

This input indicates the number of insights to fetch
skip
 skip integer

This input indicates the number of items to skip when fetching insights

Returns

Body
EmailInsightListResponseEnvelope

Enrich key sales info (Preview)

Operation ID:
scp-get-sales-highlights

This action gets additional sales insights that will be shown in C4S key sales info card in outlook sidecar. The action enhances the existing skills of Copilot for sales

Parameters

Name Key Required Type Description
recordType
 recordType True string

This input identifies the record type in CRM for which key sales info is requested
recordId
 recordId True string

This input provides the unique identifier of the CRM record for which key sales info is requested
crmType
 crmType string

This input indicates the type of CRM in which the CRM record exists, for which key sales info is requested
crmOrgUrl
 crmOrgUrl string

This input indicates the URL of the CRM environment in which the CRM record exists, for which key sales info is requested
top
 top integer

This input indicates the number of sales highlights to fetch
skip
 skip integer

This input indicates the number of items to skip when fetching sales highlights

Returns

Body
SalesHighlightListResponseEnvelope

Definitions

Activity

Name Path Type Description
title
 title string

This output indicates the title of the activity in the citation card
description
 description string

This output indicates the description of the insight
dateTime
 dateTime date-time

This output indicates the time associated with the insight
url
 url string

This output indicates the URL to open insight
additionalProperties
 additionalProperties object

This output indicates additional properties displayed in the detailed view of the insight

ActivityListResponseEnvelope

Name Path Type Description
value
 value array of Activity
hasMoreResults
 hasMoreResults boolean

This indicates whether there are more results to be fetched in subsequent calls

AdaptiveCardWrapper

Name Path Type Description
adaptiveCard
 adaptiveCard string
previewCardData
 previewCardData PreviewCardData

EmailInsight

Name Path Type Description
title
 title string

This output indicates the title of the partner section and should include only the partner's name
description
 description string

This output indicates the text you would like to be included in the email summary

EmailInsightListResponseEnvelope

Name Path Type Description
value
 value array of EmailInsight
hasMoreResults
 hasMoreResults boolean

This indicates whether there are more results to be fetched in subsequent calls

ExternalRelatedRecord

Name Path Type Description
recordId
 recordId string

This output uniquely identifies each related record returned by the action
recordTypeDisplayName
 recordTypeDisplayName string

This output indicates the display name of record type of each related record returned by the action
recordTitle
 recordTitle string

This output indicates the title of each related record returned by the action
recordTypePluralDisplayName
 recordTypePluralDisplayName string

This output indicates the plural display name of the record type of each related record returned by the action
recordType
 recordType string

This output indicates the type of each related record returned by the action
url
 url string

This output indicates the URL of each related record returned by the action
additionalProperties
 additionalProperties object

This output indicates additional properties as name-value pairs of each related record returned by the action

ExternalRelatedRecordListResponseEnvelope

Name Path Type Description
value
 value array of ExternalRelatedRecord
hasMoreResults
 hasMoreResults boolean

This indicates whether there are more results to be fetched in subsequent calls

PartnerConnectorResponse

Name Path Type Description
adaptiveCards
 adaptiveCards array of AdaptiveCardWrapper

PreviewCardData

Name Path Type Description
title
 title string
subtitle
 subtitle string
url
 url string

SalesHighlight

Name Path Type Description
title
 title string

This output indicates the title of citation card for the insight.
description
 description string

This output indicates the text of the insight to be included in key sales info.
dateTime
 dateTime date-time

This output indicates the time associated with the insight.
url
 url string

This output indicates the URL to learn more about the insight.
additionalProperties
 additionalProperties object

This output indicates additional properties as name-value pairs of each related insight returned by the action.

SalesHighlightListResponseEnvelope

Name Path Type Description
value
 value array of SalesHighlight
hasMoreResults
 hasMoreResults boolean

This indicates whether there are more results to be fetched in subsequent calls