Skip to content
English
More support
Contact us
  • There are no suggestions because the search field is empty.

How to use the Oplead API ?

Our API allows you to integrate your own applications and services with the Oplead platform to automate lead management. This guide provides an overview of the main features of the API.

Accessing the API Documentation

You can access the full Oplead API documentation at:
👉 https://api.oplead.com/documentation/index.html

This documentation uses Swagger, offering an interactive interface where you can explore and test the available API methods.

For detailed technical instructions on importing leads via the API, please refer to our developer-focused guide.

Main Features of the Oplead API

1. Lead Management

  • Endpoint: /leads

  • Description: Create new leads and retrieve lead information.

2. Attachment Import

  • Endpoint: /leads/{leadIdentifier}/document/add

  • Description: Import attachments such as quotes or invoices for a specific lead.

3. Lead Status Management

  • Endpoint: /leads/{leadIdentifier}/status

  • Description: Update the status of a lead — for example, move it to “In progress” or “Nursery”.

4. Subscribe to Webhooks (automated updates)

  • Endpoint: /subscriptions

  • Receive notifications when:

    • A new lead is assigned

    • A lead’s status changes

    • An appointment related to a lead is updated

5. Set up a feedback loop when importing leads

  • If you’re a lead provider:
    You can send your leads directly into an Oplead user’s system, and automatically receive updates on how your leads are being processed — ready to integrate into your own system.

  • If you’re an Oplead user receiving leads from a provider, manufacturer, or network:
    Ask them to send their leads directly into your Oplead platform!
    You’ll save time on processing, and they’ll automatically get feedback — no need to update their intranet, partner portal, or other systems 😁

How?
When importing a lead (see point 1 — endpoint /leads), include:

  • The provider name in the field provider.name

  • The URL where you want to receive status updates for that lead in provider.url

Request Limits

Please note that the request limit is 100 requests per minute.
Make sure to handle your calls accordingly to avoid exceeding the limit.

FAQ

Q: How can I get an authentication token?
A:
An API access token is required. You can find it under Settings (gear icon) → API → “Oplead API” tab.
A token acts as your API login and password and grants access to your platform’s data.

Different types of tokens are available depending on the level of access:

  • Lead provider access:

    • Can send you leads

    • Receives automated feedback only on those leads

    • Can view your platform configuration (e.g., available marketing channels, custom fields, etc.) to adapt its lead submissions
      To create access for a new provider, click the button shown by bubble 3 in the image below and copy the provider’s key to share with them.

  • Internal or partner access:

    • Can create, update, or view all leads and statistics
      Each user has their own API key since they don’t see the same leads.

    • To access a specific user’s leads, use their API key

    • To access all platform leads, use the client admin key (recommended).
      You can copy the API key of a chosen user via the button marked by bubble 4 in the image below.

Q: Can I import quotes and invoices?
A: Yes — use the endpoint /leads/{leadId}/attachments to upload files such as quotes and invoices.

Q: Can this integration set a lead’s status to “Quote to follow up”?
A: Yes — the integration can update a lead’s status to “Quote follow-up.”
Upcoming features will include the ability to change the lead’s status automatically when importing or uploading attachments.