This documentation is designed to guide developers (with basic knowledge of REST APIs) through the process of integrating leads via the Oplead API. We cover different integration scenarios regardless of the source system.

This API is provided to import leads in real time through any source of data of your choice such as forms (Web Forms) or no-code workflow apps (Zapier, Make, …)

Don’t use it to import a large dataset of existing leads. Please use the Mass Import feature in Oplead to do that.

Prerequisites

Before starting the integration, please ensure that you have:

• A valid API Token to access the endpoints. This is provided by the administrator of the platform, please contact them and should be provided in the X-Api-Token header value.

Vocabulary

• A Marketing Channel is
• An Origin
• A Delay
• A Request Type

Requirements

A lead must have the below information. Make sure that the contact you will import will have these information

• A lastname
• An email
• A country
• A postcode
• A marketing channel

<aside> 💡

The marketing channel may be created automatically depending on your platform configuration (in general, this is the default configuration, else, the marketing channel will be ignored and put in the lead’s comment)

</aside>

Recommandations and tips