POST Trigger

Dispatch Surveys

POST https://api.feedbackly.com/v5.0.3/triggers/rest/:apiActionId

Dispatch API have rate limit of 500 contacts/minute. Please be careful with retries since we're sending out surveys right away after receiving the API request. *Refer to "Preparing Campaign" to get apiActionId from feedbackly dashboard.

Headers

Name	Type	Description
Authorization	String	Authentication token to access the API eg: 'Authorization': 'ey0iuefoo834xcunerun348efnsd'
Content-Type	String	Use: 'Content-Type':'application/json'

Request Body

Name	Type	Description
actionId*	String	Unique identifier to differentiate original requests. Feedbackly will block requests with duplicate actionIds.
contacts*	contact[]	Array of contact objects
apiActionId	String	[DEPRECIATED] ApiActionId to be used in body instead of URI param

Request (POST)

{
  "actionId": "123456789",
  "contacts": [
    {
    "email": "[e-mail]",
    "metadata": {
      "type": "Test"
      }
    }
  ]
}

200 Response successfully retrieved.

{
    "campaigns": {
        "65f16af0d948b98372d6b6aa": [
            {
                "email": "[e-mail]",
                "metadata": {
                    "type": "Test"
                }
            }
        ]
    }
}

Contact Object

Please note that either email or phone must be existing per contact. Metadata and options are optional.

Field	Type	Description
email	String	Valid email address of survey receiver
phone	String	Valid phone number with country code of survey receiver. (with or without + in the beginning)
metadata	{[key:string]: string | number}	Contact related metadata.
options	{}	Additional options

Options

To override default admin notification receivers, use this. Multiple emails can be specified as an array.

"options":{
	"notificationReceiver":["[e-mail]"],
	"overrideDefaultReceivers":true
}