Skip to main content
Skip table of contents


In order to setup the connector you will first need to retrieve your API key from Optimail.

To do this:

  • Log in to your Optimail account.

  • Select the Integrations option in the header of the page.

  • Select API Key & Integration Guide, and on this page you will see a field labeled Account API ID.

Clicking on this field will copy it to your clipboard, navigate back to the connector setup in Cyclr and paste this into the API Key field and press next.

The connector is now authenticated and ready to use.

Retrieve Campaign IDs

The methods under Subscriptions require a Campaign ID. You can't obtain the Campaign ID through an API call, so you need to go to the Optimail portal:

  1. Select Campaigns in the page header.

  2. Select the campaign you need the ID for.

  3. Copy the CAMPAIGN API ID field in the bottom left of the Campaign page.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.