Connectors Reference

Dynamics 365 Customer Voice

Use Dynamics 365 Customer Voice to quickly create and send customized surveys to keep in close contact with your customers. View responses in automatically generated reports that highlight important trends and flag outlier scores for immediate attention. Track the customer metrics that matter the most to your business to make informed decisions.

 

Status: Production

Tier: Standard

Version: 1.1

 

Actions:

Name

Summary

getFormsPipeData (string FormId)

Retrieves the schema of the pipes configured in this survey

sendSurvey (string to, string ProjectId, string FormId, string EmailTemplateId, [advanced][Optional]string Regarding, [advanced][Optional]string RecipientInfo, [advanced][Optional]string firstName, [advanced][Optional]string lastName, [Optional]sendSurveyParameterItem item)

Send a survey

GetProject ()

Retrieve user owned and shared projects

GetSurvey (string ProjectId)

Retrieve user owned and shared surveys

GetTemplates (string FormId)

Retrieve user email templates

createSurveyInvite (string ProjectId, string FormId, [Optional]string Email, [advanced][Optional]string subject, [advanced][Optional]string firstName, [advanced][Optional]string lastName, [advanced][Optional]string Regarding, [advanced][Optional]string RecipientInfo, [Optional]createSurveyInviteParameterItem item)

Create an invitation

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

createSurveyInviteParameterItem

The fields to send to WebMerge

createSurveyInviteResponse

 

getFormsPipeDataResponse

 

GetProjectResponseItem

 

GetSurveyResponseItem

 

sendSurveyParameterItem

The fields to send to WebMerge

 

Actions:

getFormsPipeData

Summary: Retrieves the schema of the pipes configured in this survey

Description: Retrieves the schema of the pipes configured in this survey.

 

Syntax:

Dynamics365CustomerVoice.getFormsPipeData (string FormId)

 

Parameters:

Name

Type

Summary

Required

Related Action

FormId

string

(Survey)

Select a survey

True

GetSurvey

 

Returns:

          Type:getFormsPipeDataResponse

 

sendSurvey

Summary: Send a survey

Description: This action sends a survey to a specified list of recipients and creates a survey invitation for each recipient.

 

Syntax:

Dynamics365CustomerVoice.sendSurvey (string to, string ProjectId, string FormId, string EmailTemplateId, [advanced][Optional]string Regarding, [advanced][Optional]string RecipientInfo, [advanced][Optional]string firstName, [advanced][Optional]string lastName, [Optional]sendSurveyParameterItem item)

 

Parameters:

Name

Type

Summary

Required

Related Action

to

string

(To)

Add a list of recipients this survey is sent to

True

ProjectId

string

(Project)

Select a project

True

GetProject

FormId

string

(Survey)

Select a survey

True

GetSurvey

EmailTemplateId

string

(Email template)

Select an email template

True

GetTemplates

Regarding

string

(Regarding)

Relate this invitation by providing an entity id and entity type from this CDS in the format: entity type name, entity id

False

RecipientInfo

string

(Recipient details)

If the recipient is from CDS, specify an entity id and entity type of the recipient to relate in the format: entity type name, entity id

False

firstName

string

(First name)

If the first name was personalized in email or used in pipe, enter the value here to replace

False

lastName

string

(Last name)

If the last name was personalized in email or used in pipe, enter the value here to replace

False

item

sendSurveyParameterItem

(The fields to send to WebMerge)

An object that represents the posting of fields.

False

 

Returns:

          Type:string

 

GetProject

Summary: Retrieve user owned and shared projects

Description: Retrieve user owned and shared projects.

 

Syntax:

Dynamics365CustomerVoice.GetProject ()

 

Returns:

          Type:array of (GetProjectResponseItem)

 

GetSurvey

Summary: Retrieve user owned and shared surveys

Description: Retrieve user owned and shared surveys.

 

Syntax:

Dynamics365CustomerVoice.GetSurvey (string ProjectId)

 

Parameters:

Name

Type

Summary

Required

Related Action

ProjectId

string

(Project)

Select a project

True

GetProject

 

Returns:

          Type:array of (GetSurveyResponseItem)

 

GetTemplates

Summary: Retrieve user email templates

Description: Retrieve user email templates.

 

Syntax:

Dynamics365CustomerVoice.GetTemplates (string FormId)

 

Parameters:

Name

Type

Summary

Required

Related Action

FormId

string

(Survey)

Select a survey

True

GetSurvey

 

Returns:

 

createSurveyInvite

Summary: Create an invitation

Description: This action creates a survey invitation and returns a personalized invitation link.

 

Syntax:

Dynamics365CustomerVoice.createSurveyInvite (string ProjectId, string FormId, [Optional]string Email, [advanced][Optional]string subject, [advanced][Optional]string firstName, [advanced][Optional]string lastName, [advanced][Optional]string Regarding, [advanced][Optional]string RecipientInfo, [Optional]createSurveyInviteParameterItem item)

 

Parameters:

Name

Type

Summary

Required

Related Action

ProjectId

string

(Project)

Select a project

True

GetProject

FormId

string

(Survey)

Select a survey

True

GetSurvey

Email

string

(Email)

The email address to identify the survey invite, Optionally enter the recipient info.

False

subject

string

(Subject)

Subject of the invitation

False

firstName

string

(First name)

If the first name was personalized in email or used in pipe, enter the value here to replace

False

lastName

string

(Last name)

If the last name was personalized in email or used in pipe, enter the value here to replace

False

Regarding

string

(Regarding)

Relate this invitation by providing an entity id and entity type from this CDS in the format: entity type name, entity id

False

RecipientInfo

string

(Recipient details)

If the recipient is from CDS, specify an entity id and entity type of the recipient to relate in the format: entity type name, entity id

False

item

createSurveyInviteParameterItem

(The fields to send to WebMerge)

An object that represents the posting of fields.

False

 

Returns:

          Type:createSurveyInviteResponse

 


 

createSurveyInviteParameterItem

Summary: The fields to send to WebMerge

Description: An object that represents the posting of fields.

 

          Properties:

Name

Type

Summary


 

createSurveyInviteResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

InvitationId

string

 

The unique identifier of the created survey invitation.

Invitationlink

string

 

The personalized invitation link of the survey.

Unsubscribelink

string

 

The unsubscribe link of the survey.


 

getFormsPipeDataResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GetProjectResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Name

string

 

 

ProjectId

string

 

 


 

GetSurveyResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Name

string

 

 

FormId

string

 

 

SurveyId

string

 

 


 

sendSurveyParameterItem

Summary: The fields to send to WebMerge

Description: An object that represents the posting of fields.

 

          Properties:

Name

Type

Summary