AutoSeller (Preview)

Microsoft AutoSeller Connector for Dynamics 365 and Power Platform
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Copilot Studio | 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) |
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) |
Contact | |
---|---|
Name | Microsoft |
URL | https://www.microsoft.com/en-us/microsoft-365 |
Connector Metadata | |
---|---|
Publisher | Microsoft Corporation |
Website | https://www.microsoft.com/en-us/microsoft-365 |
Privacy policy | https://privacy.microsoft.com/ |
Categories | Productivity |
Autonomous SDR connector is for performing various actions using AutoSDR service.
Creating a connection
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Activity Log |
Explicitly write activity logs to dataverse. |
Append Event To Engagement Context |
Appends an event to the engagement context. |
Check Engagement Context Exists |
Checks if an engagement context exists for the given engagement ID. |
Create Engagement Context |
Creates a new engagement context with the given playbook. |
Determine Memory Update |
Makes a decision on the memory update to apply to memory contents based on the engagement context. |
Determine Outreach Action |
Call outreach email generation agent. |
Determine Reply Action |
Call reply generation agent. Assumes prior gathered knowledge. |
Determine Stage |
Makes a decision on the current stage of the engagement context. |
Determine Stage Status |
Makes a decision on the status of the current stage of the engagement context. |
Determine Tool Calls |
Generates a list of calls to make to a tool. |
Engagement Determine System Reply Action |
Determine the appropriate system reply action based on engagement context. |
Engagement Generate Researched Outreach |
Generate a researched outreach message based on the provided engagement ID. |
Engagement Generate Researched Reply (Workflow) |
Generate a researched reply using the provided engagement ID in the workflow context. |
Gather Reply Knowledge |
Gathers knowledge to prepare for an email reply. |
Generate Researched Outreach |
Trigger out reach email generation. |
Generate Researched Reply |
Gathers knowledge, appends it to the engagement context as an event, and generates a reply. |
Get All Playbooks |
Gets all playbooks. |
Get Playbook |
Gets a playbook by ID. |
Get Researched Outreach Result |
Get the result of Determine Outreach Action. |
Get Task Status |
Get the status of the task by id. |
Health |
Health endpoint. |
Jobs Determine Stage and Status |
Trigger stage and status determination. |
Jobs Generate Researched Reply |
Trigger reply generation agent. |
Jobs Get Determine Stage and Status Result |
Get result of stage and status determination. |
Jobs Get Researched Reply Result |
Get the result of Determine Reply Action. |
Retrieve Engagement Context |
Retrieves the engagement context for the given engagement ID. |
Update Engagement Context Memory |
Updates the memory of the engagement context with the given key-value pairs. |
Update Engagement Current Stage |
Updates the engagement context to be in the given stage. |
Update Engagement Current Stage Status |
Updates the engagement context to have the given stage status. |
Activity Log
Explicitly write activity logs to dataverse.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
type
|
type | integer | ||
agentName
|
agentName | True | integer | |
engagementId
|
engagementId | True | uuid | |
runId
|
runId | True | string | |
correlationId
|
correlationId | uuid | ||
logLevel
|
logLevel | integer | ||
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Append Event To Engagement Context
Appends an event to the engagement context.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Engagement id.
|
engagementId | True | string |
Engagement id |
|
object | |||
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
Check Engagement Context Exists
Checks if an engagement context exists for the given engagement ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Engagement id.
|
engagementId | True | string |
Engagement id |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
Create Engagement Context
Creates a new engagement context with the given playbook.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Request body payload.
|
body | True | string |
Request body payload |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
- response
- string
Determine Memory Update
Makes a decision on the memory update to apply to memory contents based on the engagement context.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
engagementId
|
engagementId | uuid | ||
playbookId
|
playbookId | True | string | |
events
|
events | object | ||
memory
|
memory | True | object | |
stageName
|
stageName | True | string | |
status
|
status | True | string | |
description
|
description | True | string | |
isReplyComponent
|
isReplyComponent | True | boolean | |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
- response
- object
Determine Outreach Action
Call outreach email generation agent.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
engagementId
|
engagementId | uuid | ||
playbookId
|
playbookId | True | string | |
events
|
events | object | ||
memory
|
memory | True | object | |
stageName
|
stageName | True | string | |
status
|
status | True | string | |
description
|
description | True | string | |
isReplyComponent
|
isReplyComponent | True | boolean | |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
Determine Reply Action
Call reply generation agent. Assumes prior gathered knowledge.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
engagementId
|
engagementId | uuid | ||
playbookId
|
playbookId | True | string | |
events
|
events | object | ||
memory
|
memory | True | object | |
stageName
|
stageName | True | string | |
status
|
status | True | string | |
description
|
description | True | string | |
isReplyComponent
|
isReplyComponent | True | boolean | |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
- Body
- ReplyActionResponse
Determine Stage
Makes a decision on the current stage of the engagement context.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
engagementId
|
engagementId | uuid | ||
playbookId
|
playbookId | True | string | |
events
|
events | object | ||
memory
|
memory | True | object | |
stageName
|
stageName | True | string | |
status
|
status | True | string | |
description
|
description | True | string | |
isReplyComponent
|
isReplyComponent | True | boolean | |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
- response
- string
Determine Stage Status
Makes a decision on the status of the current stage of the engagement context.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
engagementId
|
engagementId | uuid | ||
playbookId
|
playbookId | True | string | |
events
|
events | object | ||
memory
|
memory | True | object | |
stageName
|
stageName | True | string | |
status
|
status | True | string | |
description
|
description | True | string | |
isReplyComponent
|
isReplyComponent | True | boolean | |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
- Body
- StageStatus
Determine Tool Calls
Generates a list of calls to make to a tool.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
engagementId
|
engagementId | uuid | ||
playbookId
|
playbookId | True | string | |
events
|
events | object | ||
memory
|
memory | True | object | |
stageName
|
stageName | True | string | |
status
|
status | True | string | |
description
|
description | True | string | |
isReplyComponent
|
isReplyComponent | True | boolean | |
description
|
description | True | string | |
isReplyComponent
|
isReplyComponent | True | boolean | |
toolSchema
|
toolSchema | True | ||
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
items
|
object |
Engagement Determine System Reply Action
Determine the appropriate system reply action based on engagement context.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
engagementId
|
engagementId | uuid | ||
playbookId
|
playbookId | True | string | |
events
|
events | object | ||
memory
|
memory | True | object | |
stageName
|
stageName | True | string | |
status
|
status | True | string | |
description
|
description | True | string | |
isReplyComponent
|
isReplyComponent | True | boolean |
Returns
- Body
- ReplyActionResponse
Engagement Generate Researched Outreach
Generate a researched outreach message based on the provided engagement ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Request body payload
|
body | True | uuid |
The engagement ID (UUID) to generate outreach for. |
Returns
Engagement Generate Researched Reply (Workflow)
Generate a researched reply using the provided engagement ID in the workflow context.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Request body payload
|
body | True | uuid |
The engagement ID (UUID) to generate the reply for. |
Returns
- Body
- ReplyActionResponse
Gather Reply Knowledge
Gathers knowledge to prepare for an email reply.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
engagementId
|
engagementId | uuid | ||
playbookId
|
playbookId | True | string | |
events
|
events | object | ||
memory
|
memory | True | object | |
stageName
|
stageName | True | string | |
status
|
status | True | string | |
description
|
description | True | string | |
isReplyComponent
|
isReplyComponent | True | boolean | |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
Generate Researched Outreach
Trigger out reach email generation.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
engagementId
|
engagementId | uuid | ||
playbookId
|
playbookId | True | string | |
events
|
events | object | ||
memory
|
memory | True | object | |
stageName
|
stageName | True | string | |
status
|
status | True | string | |
description
|
description | True | string | |
isReplyComponent
|
isReplyComponent | True | boolean | |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
- Body
- TriggerTaskResponse
Generate Researched Reply
Gathers knowledge, appends it to the engagement context as an event, and generates a reply.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
engagementId
|
engagementId | uuid | ||
playbookId
|
playbookId | True | string | |
events
|
events | object | ||
memory
|
memory | True | object | |
stageName
|
stageName | True | string | |
status
|
status | True | string | |
description
|
description | True | string | |
isReplyComponent
|
isReplyComponent | True | boolean | |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
- Body
- ReplyActionResponse
Get All Playbooks
Gets all playbooks.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
- response
- object
Get Playbook
Gets a playbook by ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Playbook id.
|
playbookId | True | string |
Playbook id |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
- Body
- Playbook
Get Researched Outreach Result
Get the result of Determine Outreach Action.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id
|
id | True | string |
Id |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
Get Task Status
Get the status of the task by id.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id
|
id | True | string |
Id |
Job name
|
jobName | True | string |
Job name |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
- Body
- TaskStatusResponse
Health
Health endpoint.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
Jobs Determine Stage and Status
Trigger stage and status determination.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
engagementId
|
engagementId | True | uuid | |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
- Body
- TriggerTaskResponse
Jobs Generate Researched Reply
Trigger reply generation agent.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
engagementId
|
engagementId | uuid | ||
playbookId
|
playbookId | True | string | |
events
|
events | object | ||
memory
|
memory | True | object | |
stageName
|
stageName | True | string | |
status
|
status | True | string | |
description
|
description | True | string | |
isReplyComponent
|
isReplyComponent | True | boolean | |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
- Body
- TriggerTaskResponse
Jobs Get Determine Stage and Status Result
Get result of stage and status determination.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id
|
id | True | string |
Id |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
Jobs Get Researched Reply Result
Get the result of Determine Reply Action.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id
|
id | True | string |
Id |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
- Body
- ReplyActionResponse
Retrieve Engagement Context
Retrieves the engagement context for the given engagement ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Engagement id.
|
engagementId | True | string |
Engagement id |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
Update Engagement Context Memory
Updates the memory of the engagement context with the given key-value pairs.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Engagement id.
|
engagementId | True | string |
Engagement id |
|
object | |||
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
Update Engagement Current Stage
Updates the engagement context to be in the given stage.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Engagement id.
|
engagementId | True | string |
Engagement id |
Request body payload.
|
body | True | string |
Request body payload |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
Update Engagement Current Stage Status
Updates the engagement context to have the given stage status.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Engagement id.
|
engagementId | True | string |
Engagement id |
stageName
|
stageName | True | string | |
status
|
status | True | string | |
description
|
description | True | string | |
isReplyComponent
|
isReplyComponent | True | boolean | |
Content-Type header
|
Content-Type | string |
Content-Type header |
|
Accept-Language header
|
Accept-Language | string |
Accept-Language header |
|
x-ms-activity-id header
|
x-ms-activity-id | True | string |
x-ms-activity-id header |
x-ms-asdr-crmorganizationurl header
|
x-ms-asdr-crmorganizationurl | True | string |
x-ms-asdr-crmorganizationurl header |
x-ms-asdr-workflowrunid header
|
x-ms-asdr-workflowrunid | True | string |
x-ms-asdr-workflowrunid header |
Returns
Definitions
Citation
Name | Path | Type | Description |
---|---|---|---|
name
|
name | string | |
text
|
text | string | |
reference
|
reference | string |
EngagementContextData
Name | Path | Type | Description |
---|---|---|---|
engagementId
|
engagementId | uuid | |
playbookId
|
playbookId | string | |
events
|
events | array of EngagementEvent | |
memory
|
memory | object | |
currentStageStatus
|
currentStageStatus | StageStatus |
EngagementEvent
Name | Path | Type | Description |
---|---|---|---|
|
object |
GatherKnowledgeResponse
Name | Path | Type | Description |
---|---|---|---|
results
|
results | array of KnowledgeRoundtrip |
GenerateEmailOutreachResponse
Name | Path | Type | Description |
---|---|---|---|
outreachEmails
|
outreachEmails | array of OutreachEmailContent |
Knowledge
Name | Path | Type | Description |
---|---|---|---|
answer
|
answer | string |
KnowledgeQuery
Name | Path | Type | Description |
---|---|---|---|
text
|
text | string | |
propertyBag
|
propertyBag | object |
KnowledgeRoundtrip
Name | Path | Type | Description |
---|---|---|---|
query
|
query | KnowledgeQuery | |
result
|
result | Knowledge | |
citations
|
citations | array of Citation |
OutreachEmailContent
Name | Path | Type | Description |
---|---|---|---|
type
|
type | OutreachEmailType | |
subject
|
subject | string | |
body
|
body | string | |
scheduledDeliveryTime
|
scheduledDeliveryTime | date-time |
OutreachEmailType
Playbook
Name | Path | Type | Description |
---|---|---|---|
stages
|
stages | array of PlaybookStage | |
description
|
description | string | |
transitions
|
transitions | array of PlaybookStageTransition | |
guidelines
|
guidelines | array of string |
PlaybookStage
Name | Path | Type | Description |
---|---|---|---|
name
|
name | string | |
description
|
description | string | |
replyGuidelines
|
replyGuidelines | array of string | |
gathers
|
gathers | array of PlaybookStageInfoPiece |
PlaybookStageInfoPiece
Name | Path | Type | Description |
---|---|---|---|
name
|
name | string | |
description
|
description | string |
PlaybookStageTransition
Name | Path | Type | Description |
---|---|---|---|
from
|
from | string | |
to
|
to | string | |
description
|
description | string | |
requiredInfo
|
requiredInfo | array of string | |
additionalCriteria
|
additionalCriteria | array of string |
DetermineStageAndStatusResponse
Name | Path | Type | Description |
---|---|---|---|
stageStatus
|
stageStatus | StageStatus | |
transitionExplanation
|
transitionExplanation | string |
OutreachActionResponse
Name | Path | Type | Description |
---|---|---|---|
outreachEmails
|
outreachEmails | array of OutreachEmailContent |
ReplyActionResponse
Name | Path | Type | Description |
---|---|---|---|
subject
|
subject | string | |
content
|
content | string | |
inScopeGuidelines
|
inScopeGuidelines | array of string | |
completions
|
completions | array of |
StageRemainingTask
Name | Path | Type | Description |
---|---|---|---|
description
|
description | string | |
isReplyComponent
|
isReplyComponent | boolean |
StageStatus
Name | Path | Type | Description |
---|---|---|---|
stageName
|
stageName | string | |
status
|
status | StageStatusType | |
remainingTasks
|
remainingTasks | array of StageRemainingTask |
StageStatusType
Status
TaskStatusResponse
Name | Path | Type | Description |
---|---|---|---|
taskStatus
|
taskStatus | Status | |
errorMessage
|
errorMessage | string | |
modifiedOn
|
modifiedOn | date-time | |
createdOn
|
createdOn | date-time | |
currentRetryCount
|
currentRetryCount | integer | |
maxRetryCount
|
maxRetryCount | integer |
TriggerTaskResponse
Name | Path | Type | Description |
---|---|---|---|
taskId
|
taskId | string | |
taskName
|
taskName | string |
string
This is the basic data type 'string'.
object
This is the type 'object'.