Add External Recipient

This is the endpoint used for adding recipients to a survey. It has a limitation of 1000 requests per minute which is reset every minute (at 00:00, not 60 seconds after the last request). Valid Survey id for existing survey needs to be provided. If your request is made before the previous one has been handled, you will get a CONFLICT error.

We automatically filter out duplicate emails and prevent the same email being uploaded and sent more than once every 10 minutes.

If you need to add a large batch of recipients at once, see our documentation for Bulk API

If adding metatags by score type (e.g. thank_you_note_promoter, thank_you_note_passive, thank_you_note_detractor) they will work only if 'Customise based on score' switch is enabled within the web interface (on the design step of the survey).

For thank_you_link_url and thank_you_link_note to work, you will also need to enable the 'Add a link' switch in the web interface.

Using this endpoint, you can also include properties and metatags

Path Params
string
required

Unique ID of a survey

Body Params
recipient
object

Recipient information data.

date

When survey should be send. Date-time in ISO 8601 format in UTC time standard.

Headers
string
required
Defaults to Bearer <token>
Responses

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json