Invitations API overview

The invitations API enables you to send service and product review invitations to customers. Use the Invitations API to create and delete email invitations, generate a service review link and get a list of existing invitation templates.

Note

You must have a valid access token to use the Invitations API. For further information, refer to Authentication overview.

To create and send a basic service review invitation, you’ll need to include the following information:

1. Your Business Unit ID. You’ll need to include this in the URL. To find your Business Unit ID, refer to Business Units overview.
2. The customer’s email address and name.
3. The customer’s locale.
4. Your internal reference number for the customer.
5. The template ID for the invitation template you want to send.
6. (Optional) A preferred send time.

To get a list of templates available to you, use the following call:

curl -X GET "https://invitations-api.trustpilot.com/v1/private/business-units/{businessUnitId}/templates"

If you’re not sure where to start, go to Create Invitation(s) and use the example curl commands.