SimplesatInstall

Summary

Send a survey by email to a customer via the Simplesat API.

Inputs

• surveyToken (required) — Survey Name or ID, loaded via getEventBasedEmailSurveys
• customerEmail (required) — Email address of the customer
• customerName — Full name of the customer
• customerCompany — Company associated with the customer
• customerId — External ID of the customer
• customerCustomAttributes — Custom attributes for the customer (JSON object)
• teamMemberId — External ID of the team member
• teamMemberEmail — Email address of the team member
• teamMemberName — Full name of the team member
• teamMemberCustomAttributes — Custom attributes for the team member (JSON object)
• ticketId — External ID of the ticket
• ticketSubject — Subject or title of the ticket
• ticketCustomAttributes — Custom attributes for the ticket (JSON object)

Output shape

API response confirming the survey was sent by email, including send status and Simplesat reference IDs.

The surveyToken parameter is required and sourced from the event-based email surveys list. All other fields are optional and map directly to Simplesat API fields for customer, team member, and ticket context.

Examples

Example 1: Send survey to customer by email

surveyToken: '12345', customerEmail: 'customer@example.com', customerName: 'John Doe'