Getting started

Pick the survey you want to use the API for, or create a new survey to test. Don’t launch the survey (or pause it so that the status is draft or off). This will prevent the survey sending out emails (it will stockpile them)

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.

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.

Add Bulk External Recipients

This is the endpoint used for adding larger batches of recipients to a survey. It has a limitation of 1000 requests per minute which is being reset every minute. Valid Survey id for existing survey needs to be provided.

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

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.

Getting started

A quick guide to getting your API setup, and testing to make sure recipients are being successfully added

Contact with Zenloop informing us about new plugin you want to develop.

Once your application is approved you will receive first part of the api_key that has to be added to every request.

api_key should contain your application unique identifier provided by Zenloop and second part which is a string that should be possible to set by the user of the plugin in Settings of your plugin. These two parts should be concatenated with dot. For example: plugin_identifier.key_from_settings

Pick the survey you want to use the API for, or create a new survey to test. Don’t launch the survey (or pause it so that the status is draft or off). This will prevent the survey sending out emails (it will stockpile them)

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.

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.

Add Bulk External Recipients

This is the endpoint used for adding larger batches of recipients to a survey. It has a limitation of 1000 requests per minute which is being reset every minute. Valid Survey id for existing survey needs to be provided.

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

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.