Once the requirements are satisified, the add-on can be installed and used by following the steps below.

Follow these simple steps to get the mail add-on up and running.

Create an API-user and generate an API-key for the user. The user needs appropriate rights to be able to search for, save and update multiple tables. Add the API-user in the group “Users” and also create a specific group for the user and configure policies for the group on the following tables.

Read Write Add Delete
Coworker X X
Company X X
Deal X X
Document X X X
History X X X
Person X X X
Todo X X X

There are two ways of installing the add-in for Outlook:

Each user install the add-in individually

Desktop client for Outlook 2013 or 2016
  1. In the desktop client for Outlook 2013 or 2016, click on “File” –> “Manage Add-ins”.
  2. In the webpage shown, press the plus-sign and select “Add from a URL”.
  3. Press next to install the add-in.
Outlook in the web

  1. In Outlook on the web, instead click on the gear icon in the top right, and select “Manage add-ins.”
  2. Press “Click here to add a custom add-in” and select “Add from URL”.
  3. Press OK to install the add-in.

A system administrator publish the add-in to all users

There are two ways of installing the Gmail add-on:

Each user install the Gmail add-on individually

  1. Go to the Lime CRM page on G Suite Marketplace:
  2. Install the add-on by pressing “Install” and follow the instructions.

A system administrator publish the add-on to all users

In this step the system administrator (NOTE! A Lime Consultant can assist the customer's administrator in this step) create a configuration for the mail add-ins using the API-key (together with the API-URL) that previously has been created.

  • Go to and enter your e-mail address (NOTE! that this should be the administrator/superusers e-mail address).
  • Enter the passcode that was automatically sent to the administrator/superusers e-mail address after they entered their email adresses (check also your spam folder for a mail from You dont need to save the passcode. Next time you log-in you receive a new passcode.

  • Go to the “Configuration” tab and press “Create new”.

  • Enter the API-key and URL to the API (observe that the URL shall not contain '/api/v1/' and must end with a '/', for example If the customer has a space in the display name, the URL must have the space in the /application/. So, if the customer name is “Demo Company”: company/

  • Save the configuration.
  • Go to the tab “Coworkers”. All coworkers are listed and from here you can select the coworkers that are supposed to use the add-on.

  • After the coworkers, that are supposed to use the add-on, have been selected - press “Send invitation to selected”. A unique access token is created per user and each user will receive the token together with instructions through e-mail.
  • Each user enter the access token through the add-on in Gmail (left picture below) or Outlook (right picture) and save before start using the add-ons.

To use the calendar synchronization feature, each user needs to consent to Lime CRM getting acces to the updates in the users calendar. This is done by clicking the settings button and “Setup sync”.

Depending on the security settings for the customers Office set-up, the customer might need to grant admin consent to the Lime CRM mail ad-din. The set-up process is one of the following:

  1. If the customer does not have any restrictions in place for allowing apps to access users' data then users will be able to just press the “Setup Sync” button.
  2. If they do have restrictions in place, an Office 365 tenant admin must grant admin consent to the application. Instructions are here:
  • Last modified: 6 weeks ago
  • by Thu Trang Tran