Invitation API

Accessing the Invitation API

To manage and create invitation clients for your organization, follow these steps:

1. Click your avatar in the top navigation panel.
2. Select Control Panel from the dropdown menu.
3. Click Invitation API.

Viewing Existing Clients:

In the Invitation API window, you can view and manage the invitation clients that have been created. Each client represents an external application that can access the Invitation API and create invitations on behalf of your organization.

Creating a New Invitation API Client

To create a new client that can manage invitations, follow these steps:

1. Click the +Create Client button.

2. A new window titled Create Invitation API Client will appear.

3. Add a Display Name for the client. This will be used to identify the client in the system.

4. Add Permissions: Choose the permissions you want the client to have. Permissions will allow the client to attach specific metadata types to invitations.

   • Reviews: Review metadata contains information about product reviews left by users in external services. Enabling this will display the review next to the user in the control panel and show a verified purchase badge on the user’s profile.
   • Group Membership: Group metadata includes the list of groups the user should be added to when they accept the invitation. This feature helps in managing Members and Advocates automatically based on the user’s actions in the external service.

5. Click Create to finalize the creation of the client.

Once the client is created, it will appear in the Invitation API window, and you can begin using it to manage invitations for your organization.

For further assistance or issues, please contact our support team.