Sending Surveys via Email Integration

Pisano can collect feedback integrated into the email services used by companies, along with the adapter infrastructure it provides.

The following steps should be followed for sending surveys via email:

• The email service provider can be configured by using interactive video
  
  
• Defining the email channel, connecting it to the relevant flow, and selecting the service provider to be used.
• Triggering the email survey

  • Manual triggering by uploading a CSV file: Preferred for bulk survey sending. Used when survey sending is not frequent on a daily basis. Since surveys will be triggered manually, preparation by the business unit is required.

  • Triggering the email survey via workflow: Preferred if bulk survey sending is desired to be done automatically at scheduled times.

  • Triggering the survey via API (Email Sharing) (on this page): Preferred for automatically triggering transaction-based surveys. Surveys can be sent immediately after the customer completes a transaction. The system sending the request decides when the API will be triggered. Once the API is triggered, email sending is facilitated

Triggering the survey via API (Email Sharing)

Endpoint Details

POST  https://<pisanoURL>/v1/email_campaigns/:campaign_id/email_sharings/

*** The pisanoURL information will be shared with you by Pisano.

Parameters

Headers (HTTP Header)

Sample cURL Request

curl --location 'https://<pisanoEnvironment>/v1/email_campaigns/<campaignID>/email_sharings' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data '{
    "emails": [
        "<email1>",
        "<email2>"
    ],
    "custom_attributes": {
        "<email1>": {
            "name": "<name1>",
            "external_id": "<external_id1>",
            "phone_number": "<phone_number1>"
        },
        "<email2>": {
            "name": "<name2>",
            "external_id": "<external_id2>",
            "phone_number": "<phone_number2>"
        }
    },
    "transactional_data": {
        "<email1>": {
            "Segment": "<Segment1>",
            "Location": "<Location1>",
            "TransactionDate": "<TransactionDate1>"
        },
        "<email2>": {
            "Segment": "<Segment2>",
            "Location": "<Location2>",
            "TransactionDate": "<TransactionDate2>"
        }
    }
}'

#   - 20 requests in 5 seconds

#   - 40 requests in 25 seconds

#   - 80 requests in 125 seconds (~2 min)

#   - 160 requests in 625 seconds (~10 min)

It is recommended as a best practice to trigger a maximum of 5000 customers in a single request.

Throttle limits for Email & SMS & Link can be increased or completely removed in on-premises installations. Throttle rules can be configured based on IP in on-premises installations

Obtaining API ID (campaign_id)

• Go to Channels > Email Channels, and click on the 'Edit Campaign' button.
  
  
• The API ID determining which campaign to send is obtained from this screen in API usage. Example API ID: 735c19a7-ee54-4b03-a84a-93dfe2a94a56
  
• In the opened screen, the service provider should be selected. If the subject of the email will not be managed by the Email service provider, it should be entered under the 'Subject' heading.

Obtaining a TOKEN

For all API usages in Pisano, you must obtain a TOKEN

API Response Codes