--- title: Email invitations triggered by an API description: Email invitations are emails sent to your contacts containing a link to your questionnaire, are customizable, and can be triggered by an API. Discover it now👉 --- [Skip to content](https://help.pointerpro.com/email-invitations-triggered-by-an-api#main-content) [![Pointerpro-logo](https://help.pointerpro.com/hs-fs/hubfs/Pointerpro-logo.png?width=188&height=53&name=Pointerpro-logo.png)](https://pointerpro.com/) - [Getting started](https://help.pointerpro.com/how-to-get-started-with-pointerpro) - [Pricing](https://pointerpro.com/pricing) - [Customer stories](https://pointerpro.com/case-studies) Open main navigation Close main navigation - [Getting started](https://help.pointerpro.com/how-to-get-started-with-pointerpro) - [Pricing](https://pointerpro.com/pricing) - [Customer stories](https://pointerpro.com/case-studies) - [New here? Explore what Pointerpro can do](https://www.pointerpro.com/) [New here? Explore what Pointerpro can do](https://www.pointerpro.com/) How can we help you? - There are no suggestions because the search field is empty. 1. [Knowledge Base](https://help.pointerpro.com/?hsLang=en) 2. [Share & Results](https://help.pointerpro.com/share-results?hsLang=en) 3. [Sharing your questionnaire](https://help.pointerpro.com/share-results?hsLang=en#sharing-your-questionnaire) # Email invitations triggered by an API Email invitations are messages sent to your contacts containing a link to your questionnaire and are fully customizable. You can [schedule an email invitation](https://help.pointerpro.com/migration/knowledge/email-invitations?hsLang=en) or you can trigger it by using an API. A Pointerpro API allows users and 3rd-party applications to access Pointerpro resources programmatically. This API conforms to REST principles. ---   ##### You'll need this: - One of these Pointerpro plans: ![](https://assets.pointerpro.com/custom/help-guide/Pointerpro+icon+Grey.svg)  Professional         ![](https://assets.pointerpro.com/custom/help-guide/Pointerpro+icon+Grey.svg)  Enterprise         ![](https://assets.pointerpro.com/custom/help-guide/Pointerpro+icon+Orange.svg)  ReportR         ![](https://assets.pointerpro.com/custom/help-guide/Pointerpro+icon+Orange.svg)  DistributR      ---   DEFINITION   An Application Programming Interface (API) is a way for two or more computer programs to communicate with each other. It is a type of software interface, that offers a service to other pieces of software. ##### On this help guide page: 1. [Default vs API-triggered email invitation](https://help.pointerpro.com/email-invitations-triggered-by-an-api#default-vs-api) 2. [Create your contacts](https://help.pointerpro.com/email-invitations-triggered-by-an-api#create) 3. [Setup an email invitation](https://help.pointerpro.com/email-invitations-triggered-by-an-api#setup) 4. [Add reminders](https://help.pointerpro.com/email-invitations-triggered-by-an-api#reminders) 5. [Use an API to trigger the invitation](https://help.pointerpro.com/email-invitations-triggered-by-an-api#api-trigger) --- #### 1. Default vs API-triggered email invitation The [default email invitation](https://help.pointerpro.com/migration/knowledge/email-invitations?hsLang=en) is time-based, meaning that the emails are set to be sent at a specific future time. To send these emails to your contacts, you must first create a contact list in Pointerpro. Once the email is sent, it cannot be reused; you must create a new email invitation for subsequent use. The API-triggered emails allow you to send identical email invitations repeatedly through an API call. In this scenario, there's no requirement to set a specific date for scheduling your emails or reminders. Instead, you can activate an API trigger by choosing an event, and your email invitation will automatically be sent to your contacts. Note that first, you would need to create the contacts in Pointerpro.  #### 2. Create your contacts The first step is to create your contacts in Pointerpro. You can do it [manually](https://help.pointerpro.com/migration/knowledge/contact-list#individually), [upload them from a CSV](https://help.pointerpro.com/migration/knowledge/contact-list#uploading), or [create them via an API](https://help.pointerpro.com/migration/knowledge/pointerpro-api#contacts).  #### 3. Setup an email invitation To create your invite, click on the avatar icon at the right-hand top corner of the screen, and then click Email invitations at the drop-down menu. ![Email invitations triggered by an API- email invitation menu](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35212790895/original/Q5qyib_nxNwWxXPiBhNQ2sGRzbNvQhUmgg.png?1697026374) Click the button Create Email to get started. ![Email invitations triggered by an API- create email](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35212800990/original/rrQ8cuEl0j6Njm3xGVK84eeadFVVTUCfgA.png?1697030853) Now a box will pop up listing all of your questionnaires. Click on the questionnaire for which you would like to create the invite.  ![Email invitations triggered by an API- select a questionnaire](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35212791072/original/6gdARJo6BI8qiHoEgqZASZBCOI_ZcqDCFw.png?1697026492) Then click Add Email. ![Email invitations triggered by an API- click add email](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213828138/original/axOvronYfxxVtITCOFDLsYPSNreZPPYmVA.png?1698060740) A new pop-up window opens, where you should select the API trigger option. If you would like to schedule the email, you can find additional information [here](https://help.pointerpro.com/migration/knowledge/email-invitations?hsLang=en). ![Email invitations triggered by an API- API trigger pop up](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35212791160/original/Tj_unzELqXex9mrJI6cVEESbK67C-0iRrA.png?1697026533) After clicking on the API trigger option, the following screen opens.  ![Email invitations triggered by an API- setup the email invitation](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213828029/original/x-tNQFo85XhBEUJq8-bYLiKITj78goUlrA.png?1698060668) To build your message, you need to add all the information required. 1. Title: you can use the name of your questionnaire or choose any title you want. This will also be the title of the template. If you are creating a few templates, make sure that your titles are clear so you will be able to differentiate between them later. 2. Sender name: you can use your own name or the company name. 3. Sender address: type the address you want to use to send the messages.  4. Subject: Make it catchy! It should be compelling enough to make people want to click and open the questionnaire. 5. Body: This is the text of your message. You can make it more exciting by formatting your text (read about the[ rich text editor](https://help.pointerpro.com/migration/knowledge/text-editor-wysiwyg?hsLang=en) icons and learn how to change the color, alignment, add emojis, and more) and personalize it with invite variables. These variables are essential if you want to track which contacts have responded. WARNING   When you are sending email invitations via API, the system uses by default the admin's account. However, Team members don't have access to the admin's contacts, and therefore the contact won’t be attached to the response. In order for the Team members to be able to see the contacts in the responses, they have to be added to the same [user group](https://help.pointerpro.com/migration/knowledge/my-team#groups). NOTE   Make sure you add the variable that includes your survey link, so you can invite your respondents to complete the survey. Click [here](https://help.pointerpro.com/migration/knowledge/email-invitations#links) to read how to do that. #### 4. Add reminders It's so much easier to set up your reminder now compared to trying to remember in the midst of data collection to reach out to those who haven't participated yet. At the bottom of the page, click Add Reminder.![Email invitations triggered by an API- add reminder](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35212805898/original/FNRDe8vJayUSgQiGZhw7rbL3zX3l-hGYEg.png?1697033076) Most options are the same as for the initial setup. You'll see an extra option, to choose from the drop-down menu what should trigger the reminder. ![Email invitations triggered by an API- which conditions should trigger the reminder](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35212806034/original/xR-zBwHZCvsJ7SMtp9TJvUZRpxF-iUxi0g.png?1697033142) You can add as many reminders as you wish. Just click Add a reminder and repeat the same steps. Now don't forget to save all your hard work. ![Email invitations triggered by an API- save ](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213828267/original/s9qJQNrxHuqaLXo6-RUEE1UqR9hQUvpUWQ.png?1698060802) Once your work is saved, the button "Copy unique identifier" will appear. You will need this button later on to trigger the email invitation.  ![Email invitations triggered by an API- copy unique identifier](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213829471/original/wVqQ9LEWDsDWBxPVEOcz9oJqBOM-nPFCOg.png?1698061512) #### 5. Use an API to trigger the invitation To trigger the email invitation by using an API call, the IT department of your company would have to set up the necessary API integration and configuration. They can find additional information here:  [https://documenter.getpostman.com/view/184445/UV5dfFca#84ef5f8d-ee8a-49d6-b598-74fb22988c50](https://documenter.getpostman.com/view/184445/UV5dfFca#84ef5f8d-ee8a-49d6-b598-74fb22988c50) NOTE   To use APIs, it is necessary to possess the Client secret and Client ID. Please contact support@pointerpro.com and they will provide you with these credentials. Alternatively, you can set this up with [Make](https://help.pointerpro.com/migration/knowledge/make-formerly-integromat-integration?hsLang=en).  5.1 [Create an HTTP module for the Authentication](https://help.pointerpro.com/email-invitations-triggered-by-an-api#authentication) 5.2 [Create an HTTP module to trigger the email invitation](https://help.pointerpro.com/email-invitations-triggered-by-an-api#email-invitation) #### 5.1 Create an HTTP module for the Authentication After logging into Make, click on "Create a new scenario." Create your first module by clicking the "+" button. ![Email invitations triggered by an API- create your first module](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213830455/original/kPc1le41xptm-a77a6Zp_-ovn-o3ap7NgQ.png?1698061991) Next, search for the HTTP module and select it from the list. ![Email invitations triggered by an API- select http](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213830583/original/2KU47VV-CPjbpTzXLg4UkvFLr8n1wpX_xA.png?1698062077) A new list will appear; choose "Make a request" from the options. ![Email invitations triggered by an API- make a request](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213830645/original/GE6S55XDacTDhIuro2uL_EZyK6lxp3ZTvQ.png?1698062117) Configure the module settings following the images provided below. ![Email invitations triggered by an API- http configuration](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213830735/original/n2SNPwgM8irrafwj-wFNMFnA8B24TU_5hQ.png?1698062197) ![Email invitations triggered by an API- http configuration](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213830964/original/v8jGo4nCHfnJZDzu-nJgqWBlJIaG_LFfuA.png?1698062309) ![Email invitations triggered by an API- http configuration](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213830994/original/Q8q26pfvCdJAix0YXASHf1d5QtFKyNiMmw.png?1698062328) NOTE   For security reasons, every organization has a unique client ID and secret. Please contact support@pointerpro.com and ask for the Client secret and Client ID.  #### 5.2 Create an HTTP module to trigger the email invitation Click on the "+" button to add another module to your scenario. ![Email invitations triggered by an API- create the second module](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213831439/original/RFHG3lL0enkY2-1bC02ayTGvDrr5QL_GbA.png?1698062541) Select "HTTP" from the new window that appears. ![Email invitations triggered by an API- select http](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213831532/original/_HYZJTmjUnrbvkgcIlpzSUG6M0dDwuH8cQ.png?1698062577) In the opened list, choose "Make a request." ![Email invitations triggered by an API- select make a request](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213831715/original/8MmOge5S7jzyXCiUEjMeYW6NVfEB28AcVw.png?1698062665) In the URL field, paste the API for the email invitation, which you can find here:  [https://documenter.getpostman.com/view/184445/UV5dfFca#0627175f-7bcc-488d-8b08-a1aaa7b0ff4b](https://documenter.getpostman.com/view/184445/UV5dfFca#0627175f-7bcc-488d-8b08-a1aaa7b0ff4b). Notice the {respondentEmail} variable. ![Email invitations triggered by an API- URL field](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213840635/original/FrE1Ivdo1wsnhI5-s1Q0Bsxp0NU7dqSBqA.png?1698066910) Now, return to your email invitation, and click on the "Copy unique identifier" button to copy the unique identifier. ![Email invitations triggered by an API- copy unique identifier](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213840849/original/wvmRxcqhOsCfIm0HXF2ewFFSTelk2LfRIQ.png?1698067019) Go back to Make and replace the {respondentEmail} variable with the value you just copied. Create headers exactly like shown in the image below.  ![Email invitations triggered by an API- http configuration](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213842582/original/LXGZd2GkwStL2QVwMOI40u9HPgVemB_WsA.png?1698067803) In the value field of the second header link the access\_token from the previous step. ![Email invitations triggered by an API- http configuration](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213842467/original/xE76adWm_MCmPhnfhpX6CyMBuPqMSxpWcg.png?1698067747) The final step is to configure the body. In the "Request content" field, paste the following text and replace the UID\_X with the unique IDs of the contacts you want to send this email invitation to. ``` { "respondents": [ "UID_1", "UID_2", "UID_3", "UID_4" ]} ``` You can find the unique ID of your contacts in the Contacts tab.  ![Email invitations triggered by an API- contact IUD](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213848444/original/P5a7m6zwzOlHKb0WeUq7isXlQiXMwp8rsA.png?1698070415) If you have many contacts, you can download them in Excel to copy all the unique IDs more quickly. ![Email invitations triggered by an API- download your contacts](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213848595/original/iagVWOJOgvAV3DL_KAkVH769JvnxW3qsPw.png?1698070489) This is how your Request content should look like. ![Email invitations triggered by an API- request contact configuration](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/35213842946/original/2ea_b4u_tvnCO4qBJuvuf2ceZNSWsUlcFQ.png?1698067966) After finishing the configuration, you should test if your scenario is working and your contacts receive an email invitation. TIP   While you're testing your setup, it's a good idea to create a contact using your own details and use this Unique ID in Make. Once you've confirmed everything is working smoothly, you can then add the Unique IDs of your other contacts. #### What's next? - [Email templates](https://help.pointerpro.com/migration/knowledge/email-templates?hsLang=en): This feature allows you to send emails to your respondents based on their selected answers or a quiz/survey score. This is a great way to keep your respondents engaged. Email templates are so useful because each email can be customized according to each respondent's answers or score using editor variables. - [PDF Scheduler](https://help.pointerpro.com/migration/knowledge/pdf-scheduler?hsLang=en): The reports sent out by the scheduler are aggregate reports with all data totaled, as opposed to personalized reports with just one set of information. You can use a PDF scheduler if you want to send a PDF report to specified contacts on a regular basis, send team members a weekly report, etc. - [Email ](https://help.pointerpro.com/migration/knowledge/email-notifications?hsLang=en)notifications: When you want to receive a notification every time the survey is completed, you can turn on Email notifications. Enter your email address and the email addresses of colleagues who need to receive the emails as well. - [Getting Started](https://help.pointerpro.com/getting-started?hsLang=en#main-content) - [Getting Started](https://help.pointerpro.com/getting-started?hsLang=en#getting-started) - [How To Guides](https://help.pointerpro.com/getting-started?hsLang=en#how-to-guides) - [Glossary](https://help.pointerpro.com/getting-started?hsLang=en#glossary) - [Build & Design](https://help.pointerpro.com/build-design?hsLang=en#main-content) - [Intro Screen & Final Screen](https://help.pointerpro.com/build-design?hsLang=en#intro-screen-final-screen) - [Question Types](https://help.pointerpro.com/build-design?hsLang=en#question-types) - [Media & Variables](https://help.pointerpro.com/build-design?hsLang=en#media-variables) - [Design your survey](https://help.pointerpro.com/build-design?hsLang=en#design-your-survey) - [Campaigns](https://help.pointerpro.com/build-design?hsLang=en#campaigns) - [FAQ](https://help.pointerpro.com/build-design?hsLang=en#faq) - [Extra Options](https://help.pointerpro.com/extra-options?hsLang=en#main-content) - [Text options](https://help.pointerpro.com/extra-options?hsLang=en#text-options) - [Question logic](https://help.pointerpro.com/extra-options?hsLang=en#question-logic) - [Custom scoring](https://help.pointerpro.com/extra-options?hsLang=en#custom-scoring) - [Quiz Options](https://help.pointerpro.com/extra-options?hsLang=en#quiz-options) - [Kiosk mode options](https://help.pointerpro.com/extra-options?hsLang=en#kiosk-mode-options) - [Data collection options](https://help.pointerpro.com/extra-options?hsLang=en#data-collection-options) - [Other options](https://help.pointerpro.com/extra-options?hsLang=en#other-options) - [Integrations & API](https://help.pointerpro.com/extra-options?hsLang=en#integrations-api) - [FAQ](https://help.pointerpro.com/extra-options?hsLang=en#faq) - [Share & Results](https://help.pointerpro.com/share-results?hsLang=en#main-content) - [Sharing your questionnaire](https://help.pointerpro.com/share-results?hsLang=en#sharing-your-questionnaire) - [View Results](https://help.pointerpro.com/share-results?hsLang=en#view-results) - [Results Dashboard](https://help.pointerpro.com/share-results?hsLang=en#results-dashboard) - [Uploading and Downloading Results](https://help.pointerpro.com/share-results?hsLang=en#uploading-and-downloading-results) - [FAQ](https://help.pointerpro.com/share-results?hsLang=en#faq) - [Report Builder](https://help.pointerpro.com/report-builder?hsLang=en#main-content) - [General](https://help.pointerpro.com/report-builder?hsLang=en#general) - [Widgets](https://help.pointerpro.com/report-builder?hsLang=en#widgets) - [Aggregate Reports](https://help.pointerpro.com/report-builder?hsLang=en#aggregate-reports) - [FAQ](https://help.pointerpro.com/report-builder?hsLang=en#faq) - [Legacy Report Builder \[deprecated\]](https://help.pointerpro.com/report-builder?hsLang=en#legacy-report-builder-deprecated) - [Dashboard Builder](https://help.pointerpro.com/dashboard-builder?hsLang=en#main-content) - [General](https://help.pointerpro.com/dashboard-builder?hsLang=en#general) - [Widgets items](https://help.pointerpro.com/dashboard-builder?hsLang=en#widgets-items) - [Distribution Portal](https://help.pointerpro.com/distribution-portal?hsLang=en#main-content) - [Configuration](https://help.pointerpro.com/distribution-portal?hsLang=en#configuration) - [Management & Administration](https://help.pointerpro.com/management-administration?hsLang=en#main-content) - [Account & Billing](https://help.pointerpro.com/management-administration?hsLang=en#account-billing) - [GDPR compliance](https://help.pointerpro.com/management-administration?hsLang=en#gdpr-compliance) - [FAQ](https://help.pointerpro.com/management-administration?hsLang=en#faq) [![Pointerpro-logo](https://help.pointerpro.com/hs-fs/hubfs/Pointerpro-logo.png?width=140&height=39&name=Pointerpro-logo.png "Pointerpro-logo")](http://pointerpro.com) Can't find what you're looking for? Contact us at [support@pointerpro.com](mailto:support@pointerpro.com) Copyright © 2026, Pointerpro