
En bref : l’API Magileads V2 (version 2.0.0, spécification OpenAPI 3.0) est l’API REST de la plateforme Magileads de prospection multicanale B2B. Elle expose 505 endpoints répartis en 47 groupes, accessibles sur https://app.api-magileads.net avec une clé transmise dans l’en-tête x-api-key. Elle permet d’automatiser l’intégralité du cycle de génération de leads : ciblage LinkedIn, Sales Navigator et Google Maps, enrichissement e-mail et téléphone, campagnes e-mail, LinkedIn et SMS, PRM, statistiques et marque blanche.
Cette page est la référence complète de l’API Magileads V2. Elle s’adresse aux développeurs, intégrateurs, Growth Ops et agences qui souhaitent connecter Magileads à leur CRM, à leurs outils no-code ou à leur back-office, et industrialiser la prospection B2B sans passer par l’interface.
L’application : application.magileads.io ou le site internet magileads.com
Fiche technique de l’API Magileads V2
| Nom | Magileads API |
|---|---|
| Version | 2.0.0 |
| Spécification | OpenAPI 3.0 (OAS 3.0), fichier swagger.json |
| Type | API REST, réponses JSON |
| URL de base | https://app.api-magileads.net |
| Authentification | Clé d’API (en-tête x-api-key) ou OAuth 2.0 |
| Fuseau horaire | Toutes les dates sont en GMT |
| Volume | 505 endpoints, 47 groupes : 154 GET, 200 POST, 82 PUT, 69 DELETE |
| Support | co*****@*******ds.eu |
Répartition des endpoints par domaine fonctionnel
| Domaine | Groupes | Endpoints |
|---|---|---|
| Accès, authentification et sécurité | Informations sur l’API, Clés d’API, OAuth 2.0, Permissions, Rôles, Clés d’API Magileads V2 externes | 31 |
| Utilisateurs, organisations et abonnements | Utilisateurs, Organisations, Équipes, Abonnements et facturation, Affiliation, Notifications, Retours utilisateurs | 73 |
| Ciblage et extraction de leads B2B | Ciblage LinkedIn et Sales Navigator, Ciblage Google Maps, Ciblage base de données | 35 |
| Données de contacts, enrichissement et conformité | Listes de contacts, Champs de données, Enrichissement par lot, Listes noires (blacklists), Désinscrits, Tags | 60 |
| Messages, modèles et agents IA | Agents IA, Modèles d’e-mails, Modèles d’invitations LinkedIn, Modèles de messages LinkedIn, Modèles SMS, Modèles SMV, Signatures e-mail | 62 |
| Campagnes multicanales (workflows) | Workflows et programmations, Jobs, Pools d’intégrations, Raccourcisseur d’URL, Formulaires | 62 |
| Canaux d’envoi et délivrabilité | Intégrations e-mail, Intégrations LinkedIn, OVH (domaines et e-mails) | 33 |
| PRM : CRM de prospection | PRM | 57 |
| Statistiques et reporting | Statistiques, Rapports | 26 |
| Automatisation et intégrations tierces | Webhooks, Zapier, Crons | 22 |
| Marque blanche (revendeurs) | Revendeurs, Revendeurs : Mailgun | 33 |
| Fichiers et dossiers | Fichiers, Dossiers | 11 |
Authentification à l’API Magileads V2
Deux mécanismes coexistent :
- Clé d’API : chaque requête porte l’en-tête
x-api-key. Les clés se gèrent par API (/api-keys) : génération, régénération et suppression. C’est la méthode adaptée aux scripts serveur et aux intégrations internes. - OAuth 2.0 : pour les applications tierces agissant au nom d’un utilisateur. Le serveur d’autorisation se découvre via
GET /.well-known/oauth-authorization-serveret supporte le flux authorization code, l’enregistrement dynamique de client, le rafraîchissement et la révocation de jetons.
Bonne pratique de sécurité : la clé d’API donne accès à toutes les données du compte. Ne l’exposez jamais côté navigateur, dans une URL partagée ou dans un dépôt de code. En cas de fuite, régénérez-la immédiatement avec PUT /api-keys/{api_key_id}/regenerate.
Démarrage rapide : premier appel
Le premier appel recommandé est GET /users/me, qui renvoie le profil du compte associé à la clé et valide la configuration.
Avec cURL
curl -X GET "https://app.api-magileads.net/users/me" \
-H "accept: application/json" \
-H "x-api-key: VOTRE_CLE_API"
En PHP (WordPress)
<?php
declare(strict_types=1);
/**
* Récupère le profil du compte Magileads associé à la clé d’API.
* La clé est lue depuis une constante définie dans wp-config.php, jamais en base ni en dur.
*
* @return array<string, mixed>|WP_Error
*/
function magileads_get_my_profile(): array|WP_Error {
if ( ! defined( 'MAGILEADS_API_KEY' ) ) {
return new WP_Error( 'magileads_no_key', 'Constante MAGILEADS_API_KEY absente.' );
}
$response = wp_remote_get(
'https://app.api-magileads.net/users/me',
array(
'timeout' => 15,
'headers' => array(
'Accept' => 'application/json',
'x-api-key' => (string) MAGILEADS_API_KEY,
),
)
);
if ( is_wp_error( $response ) ) {
return $response;
}
$code = (int) wp_remote_retrieve_response_code( $response );
if ( 200 !== $code ) {
return new WP_Error( 'magileads_http_' . $code, 'Réponse HTTP inattendue.' );
}
$data = json_decode( wp_remote_retrieve_body( $response ), true );
return is_array( $data ) ? $data : new WP_Error( 'magileads_json', 'JSON invalide.' );
}
En JavaScript (Node.js, côté serveur uniquement)
// Appel côté serveur : la clé reste dans une variable d’environnement.
const res = await fetch("https://app.api-magileads.net/users/me", {
headers: { accept: "application/json", "x-api-key": process.env.MAGILEADS_API_KEY }
});
if (!res.ok) throw new Error(`Magileads API : HTTP ${res.status}`);
const profile = await res.json();
Cas d’usage de l’API Magileads V2
1. Constituer une audience B2B qualifiée
Les endpoints Targeting – LinkedIn, Targeting – Google et Targeting – Database alimentent des listes de contacts à partir de recherches Sales Navigator, d’engagements sur des posts LinkedIn, de visiteurs de profil ou de fiches Google Maps.
2. Enrichir et nettoyer les données
Les lots Enrich et les endpoints d’enrichissement e-mail et mobile complètent les fiches. Les blacklists et les désinscrits s’appliquent directement aux listes pour respecter le RGPD avant tout envoi.
3. Lancer des séquences multicanales personnalisées par IA
Les modèles e-mail, invitations et messages LinkedIn se génèrent par IA puis s’assemblent dans un workflow, programmé sur des comptes d’envoi regroupés en pools avec warmup SMTP.
4. Traiter les réponses dans le PRM
Le PRM centralise les répondants : qualification positive ou négative, suggestion de réponse par IA, notes, appels, statuts personnalisés et nurturing.
5. Mesurer et synchroniser
Les statistiques analysent les répondants par secteur, taille d’entreprise, pays ou canal. Les webhooks et Zapier poussent les événements vers le CRM.
Référence complète des 505 endpoints de l’API Magileads V2
Les endpoints sont regroupés par domaine fonctionnel. Les segments entre accolades (par exemple {contact_list_id}) sont des paramètres de chemin. {file_type} désigne le format d’export demandé. Les descriptions reprennent les libellés officiels de la spécification OpenAPI.
Accès, authentification et sécurité
Points d’entrée qui contrôlent l’accès à l’API : clés d’API, serveur d’autorisation OAuth 2.0, rôles, permissions et clés d’API de services tiers. 31 endpoints.
Informations sur l’API API
Retourne les métadonnées de l’API, globalement ou pour un domaine SaaS donné (instance en marque blanche). 2 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /api | Api information |
| GET | /api/{saas_domain} | Api information |
Clés d’API API Keys
Cycle de vie complet des clés d’API (token) : génération, mise à jour, régénération et révocation. La régénération invalide l’ancienne clé. 6 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /api-keys | Fetch list |
| GET | /api-keys/{api_key_id} | Find profile |
| POST | /api-keys | Generate an API Key (token) |
| PUT | /api-keys/{api_key_id} | Update profile |
| PUT | /api-keys/{api_key_id}/regenerate | Regenerate an API Key (token) |
| DELETE | /api-keys/{api_key_id} | Delete an API Key |
OAuth 2.0 OAuth
Serveur d’autorisation conforme OAuth 2.0 : découverte via /.well-known/oauth-authorization-server, flux authorization code, enregistrement dynamique de client, échange et rafraîchissement de jetons, révocation et clés de signature JWKS. 8 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /.well-known/oauth-authorization-server | Discover the OAuth authorization server |
| GET | /oauth/authorization-transactions/{transaction_id} | Fetch an OAuth consent transaction |
| GET | /oauth/authorize | Start an authorization-code flow |
| GET | /oauth/jwks.json | Fetch OAuth signing keys |
| POST | /oauth/authorization-transactions/{transaction_id} | Approve or deny an OAuth consent transaction |
| POST | /oauth/register | Register an OAuth client dynamically |
| POST | /oauth/revoke | Revoke an OAuth token |
| POST | /oauth/token | Exchange or refresh OAuth tokens |
Permissions Permissions
Lecture et modification unitaire ou par lot des permissions accordées à chaque utilisateur. 5 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /permissions | Fetch list |
| GET | /permissions/{user_id} | Fetch list of a user |
| PUT | /permissions/{permission_name}/{user_id} | Update a user permission |
| PUT | /permissions/{user_id} | Batch update user permissions |
| DELETE | /permissions/{permission_name}/{user_id} | Delete a permission |
Rôles Roles
Création et gestion des rôles qui regroupent les droits des utilisateurs. 5 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /roles | Fetch list |
| GET | /roles/{role_id} | Find profile |
| POST | /roles | Create a role |
| PUT | /roles/{role_id} | Update profile |
| DELETE | /roles/{role_id} | Delete a role |
Clés d’API externes External API keys
Stockage des clés de services tiers (fournisseurs d’enrichissement, OVH…) utilisées ensuite par d’autres endpoints via {external_api_key_id}. 5 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /external-api-keys | Fetch list |
| GET | /external-api-keys/{external_api_key_id} | Find profile |
| POST | /external-api-keys | Add profile |
| PUT | /external-api-keys/{external_api_key_id} | Update profile |
| DELETE | /external-api-keys/{external_api_key_id} | Delete profile |
Utilisateurs, organisations et abonnements
Gestion des comptes utilisateurs, des organisations, des équipes, de la facturation et des notifications. 73 endpoints.
Utilisateurs Users
Inscription, authentification (avec rafraîchissement), connexion via fournisseurs tiers, profil courant (/users/me), avatar, mot de passe, vérification SMS, bascule entre comptes et génération d’un jeton de recherche embarquée. 26 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /users/{user_id} | Find profile by ID |
| GET | /users/list | Retrieve the list of users |
| GET | /users/me | Find my profile |
| GET | /users/me/quick | Find my profile (quick version) |
| POST | /oauth/{provider}/redirect | Register or login using third party logins |
| POST | /users/{user_id}/avatar | Upload an avatar to a user account |
| POST | /users/authentication | Authentication |
| POST | /users/authentication/refresh | Refresh authentication |
| POST | /users/list/search | Search users |
| POST | /users/me/avatar | Upload an avatar to my user account |
| POST | /users/me/embed/search-list/token | Generate an embedded search token |
| POST | /users/register | Register |
| POST | /users/switch/to/{user_id} | Switch to a user account |
| POST | /users/verification/sms/resend | Resend SMS verification code |
| PUT | /users/{user_id} | Update profile by ID |
| PUT | /users/{user_id}/disable | Disable by ID |
| PUT | /users/me | Update my profile |
| PUT | /users/me/disable | Disable |
| PUT | /users/password/forgot | Forgot password |
| PUT | /users/password/reset | Reset password |
| PUT | /users/unlock | Unlock user account |
| PUT | /users/verification/sms/confirm | Confirm account via SMS code |
| DELETE | /users/{user_id} | Delete an user account |
| DELETE | /users/{user_id}/avatar | Delete the avatar of a user account |
| DELETE | /users/me | Delete my user account |
| DELETE | /users/me/avatar | Delete the avatar from my user account |
Organisations Organizations
Création d’organisations, invitation et adhésion d’utilisateurs, gestion des niveaux et des rôles des membres. 11 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /organizations | Fetch list |
| GET | /organizations/{organization_id} | Find profile |
| GET | /organizations/{organization_id}/users | Fetch users list |
| POST | /organizations | Create an organization |
| POST | /organizations/{organization_id}/invite | Invite an user to an organization |
| POST | /organizations/join | Join an organization |
| PUT | /organizations/{organization_id} | Update profile |
| PUT | /organizations/{organization_id}/level/{user_id} | Update the level of a user |
| PUT | /organizations/{organization_id}/role/{user_id} | Update the role of an user |
| DELETE | /organizations/{organization_id} | Delete an organization |
| DELETE | /organizations/{organization_id}/leave | Leave an organization |
Équipes Teams
Équipes au sein d’un compte : invitations, adhésion, niveaux et rôles des membres. 10 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /teams/{team_id} | Find profile |
| GET | /teams/{team_id}/users | Fetch users list |
| POST | /teams | Create a team |
| POST | /teams/{team_id}/invite | Invite an user to a team |
| POST | /teams/join | Join a team |
| PUT | /teams/{team_id} | Update profile |
| PUT | /teams/{team_id}/level/{user_id} | Update the level of a user |
| PUT | /teams/{team_id}/role/{user_id} | Update the role of an user |
| DELETE | /teams/{team_id} | Delete a team |
| DELETE | /teams/{team_id}/leave | Leave a team |
Abonnements et facturation Subscriptions
Produits, souscription et résiliation, options d’abonnement, moyens de paiement, informations client et téléchargement des factures. 12 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /subscriptions/invoices | Fetch client invoices list |
| GET | /subscriptions/invoices/download/{invoice_id} | Download client invoice |
| GET | /subscriptions/products | Fetch products list |
| POST | /subscriptions/add/payment-method | Add and set default payment method |
| POST | /subscriptions/subscribe | Subscribe |
| POST | /subscriptions/subscribe/{user_id} | Subscribe |
| POST | /subscriptions/update/customer-info | Update customer information |
| POST | /subscriptions/update/default-payment-method | Update the default payment method |
| PUT | /subscriptions/add/options | Add Subscription Options |
| DELETE | /subscriptions/remove/options | Remove Subscription Options |
| DELETE | /subscriptions/unsubscribe | Unsubscribe |
| DELETE | /subscriptions/unsubscribe/{user_id} | Unsubscribe |
Affiliation Affiliation
Liste des utilisateurs rattachés au programme d’affiliation. 1 endpoint.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /affiliation/users | Fetch users list |
Notifications Notifications
Notifications et alertes de compte : lecture, marquage lu/non lu, masquage et paramètres de notification. 12 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /notifications | Fetch notifications |
| GET | /notifications/alerts | Fetch account alerts |
| GET | /notifications/settings | Fetch notification settings |
| PUT | /notifications/alerts/hide | Hide an account alert |
| PUT | /notifications/alerts/unhide | Unhide an account alert |
| PUT | /notifications/hide | Hide notifications |
| PUT | /notifications/hide-all | Hide all notifications |
| PUT | /notifications/read | Mark notifications as read |
| PUT | /notifications/read-all | Mark all notifications as read |
| PUT | /notifications/settings | Update notification settings |
| PUT | /notifications/unhide | Unhide notifications |
| PUT | /notifications/unread | Mark notifications as unread |
Retours utilisateurs Feedbacks
Envoi d’un retour (feedback) à l’équipe Magileads. 1 endpoint.
| Méthode | Endpoint | Description |
|---|---|---|
| POST | /feedbacks | Send a feedback |
Ciblage et extraction de leads B2B
Génération de leads : extraction de contacts et d’entreprises depuis LinkedIn, Sales Navigator, Google Maps et la base de données Magileads. 35 endpoints.
Ciblage LinkedIn et Sales Navigator Targeting – LinkedIn
Extraction de profils et d’entreprises depuis les recherches LinkedIn et Sales Navigator (modes asynchrone, synchrone et alternatif), des connexions, des membres de groupes, des participants à un événement, des visiteurs de profil ou de page entreprise, des interactions sur les posts (likes, commentaires, partages), de l’activité des profils et des publicateurs d’offres d’emploi. Inclut la génération d’URL de recherche et la recherche d’identifiants de localisation. 27 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| POST | /targeting/linkedin/{contact_list_id}/relaunch-errors | Relaunch LinkedIn extractions with errors |
| POST | /targeting/linkedin/extract-companies-search-sync | Extract LinkedIn companies from a company search (synchronous) |
| POST | /targeting/linkedin/extract-company-viewers | Extract LinkedIn company viewers |
| POST | /targeting/linkedin/extract-connections | Extract contacts from LinkedIn connections |
| POST | /targeting/linkedin/extract-event-attendees | Extract LinkedIn event attendees |
| POST | /targeting/linkedin/extract-group-members | Extract LinkedIn group members |
| POST | /targeting/linkedin/extract-people-comment-activity | Extract LinkedIn people comment activity |
| POST | /targeting/linkedin/extract-people-post-activity | Extract LinkedIn people post activity |
| POST | /targeting/linkedin/extract-people-reaction-activity | Extract LinkedIn people reaction activity |
| POST | /targeting/linkedin/extract-peoples-search | Extract contacts from a LinkedIn search |
| POST | /targeting/linkedin/extract-peoples-search-alternative | Extract contacts from a LinkedIn search (alternative) |
| POST | /targeting/linkedin/extract-peoples-search-sync | Extract LinkedIn profiles from a people search (synchronous) |
| POST | /targeting/linkedin/extract-post-commenters | Extract contacts who commented on a LinkedIn post |
| POST | /targeting/linkedin/extract-post-likers | Extract contacts who liked a post on LinkedIn |
| POST | /targeting/linkedin/extract-post-reposters | Extract LinkedIn post reposters |
| POST | /targeting/linkedin/extract-posts | Extract posts on LinkedIn |
| POST | /targeting/linkedin/extract-posts-sync | Extract LinkedIn posts (synchronous) |
| POST | /targeting/linkedin/extract-profile-viewers | Extract LinkedIn profile viewers |
| POST | /targeting/linkedin/extract-publishers-job-offers | Extract the publishers of job offers on LinkedIn |
| POST | /targeting/linkedin/extract-sales-navigator-companies-search | Extract companies from a Sales Navigator search |
| POST | /targeting/linkedin/extract-sales-navigator-companies-search-alternative | Extract companies from a Sales Navigator search (alternative) |
| POST | /targeting/linkedin/extract-sales-navigator-peoples-search | Extract contacts from a Sales Navigator search |
| POST | /targeting/linkedin/extract-sales-navigator-peoples-search-alternative | Extract contacts from a Sales Navigator search (alternative) |
| POST | /targeting/linkedin/generate-peoples-search-url | Generate a Linkedin peoples search url |
| POST | /targeting/linkedin/generate-sales-navigator-peoples-search-url | Generate a Linkedin Sales Navigator peoples search url |
| POST | /targeting/linkedin/locations/search | Search linkedin location ids |
| POST | /targeting/linkedin/refresh/{contact_list_id} | Refresh LinkedIn targeting on a contact list |
Ciblage Google Maps Targeting – Google
Extraction d’entreprises et de contacts depuis des recherches Google Maps, génération d’URL de recherche et relance des extractions (y compris celles en erreur). 4 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| POST | /targeting/google/extract-maps-search | Extract contacts from a Google Maps Search |
| POST | /targeting/google/extract-maps-search/{contact_list_id}/relaunch | Relaunch extractions |
| POST | /targeting/google/extract-maps-search/{contact_list_id}/relaunch-errors | Relaunch extractions with errors |
| POST | /targeting/google/generate-maps-search-urls | Generate Google Maps Search URLs |
Ciblage base de données Targeting – Database
Comptage, prévisualisation et extraction de contacts depuis la base de données Magileads à partir de filtres, avec recherche de localisations. 4 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| POST | /targeting/database/count | Count the number of contacts found with the given filters |
| POST | /targeting/database/count-preview | Count and preview contacts based on filters |
| POST | /targeting/database/extract | Extract contacts found with the given filters |
| POST | /targeting/database/locations/search | Search database location |
Données de contacts, enrichissement et conformité
Stockage, structuration et enrichissement des contacts, plus les listes d’exclusion indispensables à la conformité RGPD. 60 endpoints.
Listes de contacts Contact Lists
Listes de contacts et contacts unitaires : pagination, recherche transverse, fusion, export par type de fichier, valeurs uniques et mise à jour en masse d’un champ. Nettoyage avancé : suppression des contacts présents dans une blacklist, dans une autre liste ou parmi les désinscrits, et limitation du nombre de contacts par entreprise. Enrichissement d’e-mail et de mobile. 26 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /contact-lists | Fetch all lists |
| GET | /contact-lists-paginated | Fetch paginated list |
| GET | /contact-lists/{contact_list_id} | Find profile |
| GET | /contact-lists/{contact_list_id}/contacts | Fetch contacts |
| GET | /contact-lists/{contact_list_id}/contacts/{contact_id} | Find contact profile |
| GET | /contact-lists/{contact_list_id}/datafields/{datafield_id}/values | Get unique values from a datafield |
| GET | /contact-lists/{contact_list_id}/download/{file_type} | Download the list of contacts |
| GET | /contact-lists/names | Fetch contact list IDs and names |
| POST | /contact-lists/contacts/search | Search contacts in all contact list |
| POST | /contact-lists/download/{file_type} | Download the list of contacts from all contacts lists |
| POST | /contact-lists/merge | Merge contact lists |
| POST | /contacts/enrich/email | Enrich a contact email from company and optional names |
| POST | /contacts/enrich/phone/mobile | Enrich a contact mobile phone from LinkedIn URL |
| PUT | /contact-lists/{contact_list_id} | Update profile |
| PUT | /contact-lists/{contact_list_id}/contacts/{contact_id} | Update contact |
| PUT | /contact-lists/{contact_list_id}/datafields/{datafield_id}/bulk-set | Bulk set datafield value |
| DELETE | /contact-lists/{contact_list_id} | Delete a contact list |
| DELETE | /contact-lists/{contact_list_id}/contacts | Delete contacts from a contact list |
| DELETE | /contact-lists/{contact_list_id}/contacts/{contact_id} | Delete Contact |
| DELETE | /contact-lists/{contact_list_id}/contacts/blacklist/{blacklist_id} | Delete contacts from a contact list found in a blacklist |
| DELETE | /contact-lists/{contact_list_id}/contacts/contact-list/{source_contact_list_id} | Delete contacts from a contact list found in another contact list |
| DELETE | /contact-lists/{contact_list_id}/contacts/unsubscribers | Delete contacts from a contact list found in unsubscribers |
| DELETE | /contact-lists/{contact_list_id}/contacts/unsubscribers/{organization_id} | Delete contacts from a contact list found in unsubscribers from an organization |
| DELETE | /contact-lists/{contact_list_id}/delete/company/{keep_contacts} | Delete contacts on a contact list to keep only a certain amount of contacts by company |
| DELETE | /contact-lists/contacts | Delete Contacts |
| DELETE | /contact-lists/contacts/selection | Delete Contacts from a selection |
Champs de données Data Fields
Champs personnalisés (data fields) attachés aux contacts. 5 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /data-fields | Fetch list |
| GET | /data-fields/{data_field_id} | Find profile |
| POST | /data-fields | Create a data field |
| PUT | /data-fields/{data_field_id} | Update profile |
| DELETE | /data-fields/{data_field_id} | Delete a data field |
Enrichissement par lot Enrich
Création de lots d’enrichissement, récupération des résultats et statistiques de consommation. 3 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /enrich/{batch_id} | Get enrich batch results |
| POST | /enrich | Create an enrich batch |
| POST | /enrich/usage | Get enrich usage statistics |
Listes noires (blacklists) Blacklists
Listes d’exclusion : création, import de données, recherche ciblée ou globale, téléchargement (avec ou sans filtre) et suppression de données. 13 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /blacklists | Fetch list |
| GET | /blacklists/{blacklist_id} | Find profile |
| GET | /blacklists/{blacklist_id}/data | Fetch data |
| GET | /blacklists/{blacklist_id}/download/{file_type} | Download the blacklist |
| POST | /blacklists | Create a blacklist |
| POST | /blacklists/{blacklist_id}/data | Import data |
| POST | /blacklists/{blacklist_id}/data/search | Search data in specific blacklist |
| POST | /blacklists/{blacklist_id}/download/{file_type} | Download the blacklist using a filter |
| POST | /blacklists/data/search | Search data in all blacklist |
| PUT | /blacklists/{blacklist_id} | Update profile |
| DELETE | /blacklists/{blacklist_id} | Delete a blacklist |
| DELETE | /blacklists/{blacklist_id}/data/{data_id} | Delete Data |
| DELETE | /blacklists/datas | Delete Datas |
Désinscrits Unsubscribers
Gestion des désinscriptions globale ou par organisation : import, recherche, téléchargement et suppression. 8 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /unsubscribers | Fetch unsubscribers |
| GET | /unsubscribers/download/{file_type} | Download the list of unsubscribers |
| GET | /unsubscribers/organization/{organization_id} | Retrieve unsubscribers from an organization |
| GET | /unsubscribers/organization/{organization_id}/download/{file_type} | Download the list of unsubscribers from an organization |
| POST | /unsubscribers | Import unsubscribers |
| POST | /unsubscribers/organization/{organization_id}/search | Search unsubscribers from specific organization |
| POST | /unsubscribers/search | Search unsubscribers from all organizations |
| DELETE | /unsubscribers/{unsubscriber_id} | Delete an unsubscriber |
Tags Tags
Étiquettes réutilisables pour segmenter les contacts. 5 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /tags | Fetch list |
| GET | /tags/{tag_id} | Find profile |
| POST | /tags | Create a tag |
| PUT | /tags/{tag_id} | Update profile |
| DELETE | /tags/{tag_id} | Delete a tag |
Messages, modèles et agents IA
Modèles de messages pour chaque canal et agents IA chargés de rédiger et personnaliser le contenu des campagnes. 62 endpoints.
Agents IA AiAgents
Création et gestion d’agents IA, génération d’un brief à partir d’un agent existant ou sans agent. 7 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /ai-agents | Fetch AI agents |
| GET | /ai-agents/{uniqid} | Find AI agent by uniqid |
| POST | /ai-agents | Create AI agent |
| POST | /ai-agents/{uniqid}/generate-brief | Generate AI agent brief |
| POST | /ai-agents/generate-brief | Generate AI agent brief without an existing agent |
| PUT | /ai-agents/{uniqid} | Update AI agent |
| DELETE | /ai-agents/{uniqid} | Delete AI agent |
Modèles d’e-mails Models – Email
Modèles d’e-mails : génération et régénération par IA (texte et HTML), personnalisation par contact, import du HTML d’une URL, copie entre comptes et envoi de tests. 15 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /models/email | Fetch list |
| GET | /models/email/{model_id} | Find profile |
| GET | /models/email/{model_id}/{contact_id} | Find AI model profile and generate content |
| GET | /models/email/{model_id}/{contact_id}/regenerate | Find AI model profile and regenerate content |
| POST | /models/email | Create an email model |
| POST | /models/email/{model_id}/copy | Copy an email model |
| POST | /models/email/{model_id}/copy/to/{user_id} | Copy an email model to user ID |
| POST | /models/email/{model_id}/regenerate | Regenerate an email model using AI |
| POST | /models/email/{model_id}/send/test | Send an email campaign on your test emails |
| POST | /models/email/generate | Generate an email model using AI |
| POST | /models/email/generate/html | Generate HTML email using AI |
| POST | /models/email/get/html/from/url | Get HTML from URL |
| POST | /models/email/send/test | Send an email campaign on your test emails without creating a model |
| PUT | /models/email/{model_id} | Update an email model |
| DELETE | /models/email/{model_id} | Delete an email model |
Modèles d’invitations LinkedIn Models – LinkedIn Invitation
Modèles de demandes de connexion LinkedIn, avec génération de contenu par IA et personnalisation par contact. 10 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /models/linkedin/invitation | Fetch list |
| GET | /models/linkedin/invitation/{model_id} | Find profile |
| GET | /models/linkedin/invitation/{model_id}/{contact_id} | Find AI model profile and generate content |
| GET | /models/linkedin/invitation/{model_id}/{contact_id}/regenerate | Find AI model profile and regenerate content |
| POST | /models/linkedin/invitation | Create a LinkedIn invitation |
| POST | /models/linkedin/invitation/{model_id}/copy | Copy a LinkedIn invitation |
| POST | /models/linkedin/invitation/{model_id}/copy/to/{user_id} | Copy a LinkedIn invitation to user ID |
| POST | /models/linkedin/invitation/generate/content | Generate LinkedIn invitation content using AI |
| PUT | /models/linkedin/invitation/{model_id} | Update a LinkedIn invitation |
| DELETE | /models/linkedin/invitation/{model_id} | Delete a LinkedIn invitation |
Modèles de messages LinkedIn Models – LinkedIn Message
Modèles de messages LinkedIn, avec génération de contenu par IA et personnalisation par contact. 10 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /models/linkedin/message | Fetch list |
| GET | /models/linkedin/message/{model_id} | Find profile |
| GET | /models/linkedin/message/{model_id}/{contact_id} | Find AI model profile and generate content |
| GET | /models/linkedin/message/{model_id}/{contact_id}/regenerate | Find AI model profile and regenerate content |
| POST | /models/linkedin/message | Create a LinkedIn message |
| POST | /models/linkedin/message/{model_id}/copy | Copy a LinkedIn message |
| POST | /models/linkedin/message/{model_id}/copy/to/{user_id} | Copy a LinkedIn message to user ID |
| POST | /models/linkedin/message/generate/content | Generate LinkedIn message content using AI |
| PUT | /models/linkedin/message/{model_id} | Update a LinkedIn message |
| DELETE | /models/linkedin/message/{model_id} | Delete a LinkedIn message |
Modèles SMS Models – SMS
Modèles de SMS : création, copie (y compris vers un autre utilisateur), mise à jour et suppression. 7 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /models/sms | Fetch list |
| GET | /models/sms/{model_id} | Find profile |
| POST | /models/sms | Create a SMS model |
| POST | /models/sms/{model_id}/copy | Copy a SMS model |
| POST | /models/sms/{model_id}/copy/to/{user_id} | Copy a SMS model to user ID |
| PUT | /models/sms/{model_id} | Update a SMS model |
| DELETE | /models/sms/{model_id} | Delete a SMS model |
Modèles SMV Models – SMV
Modèles SMV : création, mise à jour, copie (y compris vers un autre utilisateur) et suppression. 7 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /models/smv | Fetch list |
| GET | /models/smv/{model_id} | Find profile |
| POST | /models/smv | Create a SMV model |
| POST | /models/smv/{model_id} | Update a SMV model |
| POST | /models/smv/{model_id}/copy | Copy a SMV model |
| POST | /models/smv/{model_id}/copy/to/{user_id} | Copy a SMV model to user ID |
| DELETE | /models/smv/{model_id} | Delete a SMV model |
Signatures e-mail Email Signatures
Signatures d’e-mail réutilisables dans les campagnes. 6 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /email-signatures | Fetch list |
| GET | /email-signatures/{email_signature_id} | Find profile |
| POST | /email-signatures | Create an email signature |
| POST | /email-signatures/{email_signature_id}/copy | Copy an email signature |
| PUT | /email-signatures/{email_signature_id} | Update profile |
| DELETE | /email-signatures/{email_signature_id} | Delete an email signature |
Campagnes multicanales (workflows)
Orchestration des séquences de prospection multicanales et de leur exécution. 62 endpoints.
Workflows et programmations Workflows
Cœur de l’automatisation : création, copie et programmation de workflows, pilotage des programmations (arrêt, reprise, archivage, par étape), contacts par étape et par type (export, copie vers une liste, ajout en blacklist), cliqueurs par lien, exclusions, envoi d’e-mails unitaires, téléchargement des EML et génération de workflows par agent IA (jobs, prévisualisation, évaluation de readiness, régénération). 39 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /workflows | Fetch list |
| GET | /workflows/{workflow_id} | Find profile |
| GET | /workflows/{workflow_id}/programmation/{workflow_programmation_id} | Find a workflow programmation |
| GET | /workflows/{workflow_id}/programmation/{workflow_programmation_id}/{contact_type} | Get contacts by workflow programmation and type |
| GET | /workflows/{workflow_id}/programmation/{workflow_programmation_id}/step/{step_id}/{contact_type} | Get contacts by workflow programmation step and type |
| GET | /workflows/{workflow_id}/programmation/{workflow_programmation_id}/step/{step_id}/click/link/{link_url} | Get clicker contacts by workflow programmation step and type and link |
| GET | /workflows/{workflow_id}/programmations | Fetch workflow programmations by workflow id |
| GET | /workflows/ai-agent/jobs | Fetch AI agent workflow generation jobs |
| GET | /workflows/ai-agent/jobs/{job_uniqid} | Fetch AI agent workflow generation status |
| GET | /workflows/exclude/programmation/{programmation_id} | List exclusions of contacts from a programmation |
| GET | /workflows/programmations | Fetch workflow programmations |
| GET | /workflows/programmations/contacts | Fetch workflow programmations contacts |
| GET | /workflows/reply/email/{reply_id}/download/eml | Download the eml of an email reply |
| GET | /workflows/sent/email/{id}/download/eml | Download the eml of an email manually sent |
| POST | /workflows | Create a workflow |
| POST | /workflows/{workflow_id}/copy | Copy a workflow |
| POST | /workflows/{workflow_id}/copy/to/{user_id} | Copy a workflow to user ID |
| POST | /workflows/{workflow_id}/image | Upload workflow image |
| POST | /workflows/{workflow_id}/program | Program a workflow |
| POST | /workflows/{workflow_id}/programmation/{workflow_programmation_id}/{contact_type}/{file_type} | Download contacts by workflow programmation and type |
| POST | /workflows/{workflow_id}/programmation/{workflow_programmation_id}/step/{step_id}/{contact_type}/{file_type} | Download contacts by workflow programmation step and type |
| POST | /workflows/{workflow_id}/programmation/{workflow_programmation_id}/step/{step_id}/{contact_type}/blacklist/{blacklist_id} | Blacklist contacts by workflow programmation step and type |
| POST | /workflows/{workflow_id}/programmation/{workflow_programmation_id}/step/{step_id}/{contact_type}/copy-to/{contact_list_id_destination} | Copy contacts of a workflow programmation step and type to a contact list |
| POST | /workflows/{workflow_id}/readiness | Evaluate AI agent workflow readiness |
| POST | /workflows/ai-agent | Queue AI agent workflow draft generation |
| POST | /workflows/ai-agent/jobs/{job_uniqid}/contact-preview | Generate grouped AI agent contact previews |
| POST | /workflows/ai-agent/regenerate | Regenerate an AI campaign message or workflow |
| POST | /workflows/send/email | Send a single email |
| POST | /workflows/send/email-with-attachments | Send a single email with attachments |
| PUT | /workflows/{workflow_id} | Update profile |
| PUT | /workflows/{workflow_id}/programmation/{workflow_programmation_id} | Update programmation profile |
| PUT | /workflows/{workflow_id}/programmation/{workflow_programmation_id}/archive | Archive a workflow programmation |
| PUT | /workflows/{workflow_id}/programmation/{workflow_programmation_id}/resume | Resume a workflow programmation |
| PUT | /workflows/{workflow_id}/programmation/{workflow_programmation_id}/step/{step_id}/resume | Resume a workflow programmation step |
| PUT | /workflows/{workflow_id}/programmation/{workflow_programmation_id}/step/{step_id}/stop | Stop a workflow programmation step |
| PUT | /workflows/{workflow_id}/programmation/{workflow_programmation_id}/stop | Stop a workflow programmation |
| PUT | /workflows/{workflow_id}/programmation/{workflow_programmation_id}/unarchive | Unarchive a workflow programmation |
| DELETE | /workflows/{workflow_id} | Delete a workflow |
| DELETE | /workflows/exclude/programmation/{exclusion_id} | Remove exclusion of a contact from a programmation |
Jobs Jobs
Suivi et arrêt des tâches asynchrones, suppression des résultats en échec. 3 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /jobs/prm/{target_id} | List prm jobs |
| DELETE | /jobs/{job_uniqid} | Stop a job |
| DELETE | /jobs/failed/{job_uniqid} | Delete failed job result |
Pools d’intégrations Pools
Regroupement de comptes d’envoi (intégrations) en pools. 7 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /pools | Fetch list |
| GET | /pools/{pool_id} | Find profile |
| POST | /pools | Create a pool |
| POST | /pools/{pool_id}/{integration_id} | Add an integration in the pool |
| PUT | /pools/{pool_id} | Update profile |
| DELETE | /pools/{pool_id} | Delete a pool |
| DELETE | /pools/{pool_id}/{integration_id} | Remove an integration in the pool |
Raccourcisseur d’URL URLs Shortener
Création unitaire ou en masse d’URL courtes utilisées dans les messages. 7 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /urls-shortener | Fetch list |
| GET | /urls-shortener/{shortened_url_id} | Find profile |
| GET | /urls-shortener/{url_code} | Find URL by URL code |
| POST | /urls-shortener | Create a shortened URL |
| POST | /urls-shortener/bulk | Create shortened URLs in bulk |
| PUT | /urls-shortener/{shortened_url_id} | Update profile |
| DELETE | /urls-shortener/{shortened_url_id} | Delete a shortened URL |
Formulaires Forms
Création, copie et gestion de formulaires. 6 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /forms | Fetch list |
| GET | /forms/{form_id} | Find profile |
| POST | /forms | Create a form |
| POST | /forms/{form_id}/copy | Copy a form |
| PUT | /forms/{form_id} | Update a form profile |
| DELETE | /forms/{form_id} | Delete a form |
Canaux d’envoi et délivrabilité
Connexion des comptes d’envoi et outils de délivrabilité (warmup, protections anti-spam, domaines). 33 endpoints.
Intégrations e-mail Integrations – Email
Comptes Gmail, Outlook, SMTP et mass mailing : découverte automatique des paramètres serveur, test de validité SMTP, réglages et statistiques de warmup, protections anti-spam reçues. 19 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /integrations/email | Fetch list |
| GET | /integrations/email/{email_account_id} | Find profile |
| GET | /integrations/email/discover/{email} | Discover email server settings using Autodiscover |
| GET | /integrations/email/protections | List the anti spam protections you have received by email |
| GET | /integrations/email/smtp/{email_account_id}/warmup | Retrieve warmup settings for an SMTP email account |
| GET | /integrations/email/smtp/{email_account_id}/warmup/stats | Retrieve warmup statistics for an SMTP email account. |
| POST | /integrations/email/gmail | Add a Gmail email account |
| POST | /integrations/email/mass-mailing | Add an email account for mass mailing |
| POST | /integrations/email/outlook | Add a Outlook email account |
| POST | /integrations/email/smtp | Add a SMTP email account |
| PUT | /integrations/email/gmail/{email_account_id} | Update a Gmail email account |
| PUT | /integrations/email/mass-mailing/{email_account_id} | Update an email account for mass mailing |
| PUT | /integrations/email/mass-mailing/{email_account_id}/force/validate | Force Mass Mailing email validation |
| PUT | /integrations/email/outlook/{email_account_id} | Update a Outlook email account |
| PUT | /integrations/email/protection/{protection_id} | Set a protection as handled |
| PUT | /integrations/email/smtp/{email_account_id} | Update a SMTP email account |
| PUT | /integrations/email/smtp/{email_account_id}/warmup | Update warmup settings for an SMTP email account |
| PUT | /integrations/email/smtp/validity/test | SMTP email accounts validity test |
| DELETE | /integrations/email/{email_account_id} | Delete an email account |
Intégrations LinkedIn Integrations – LinkedIn
Connexion de comptes LinkedIn, résolution des checkpoints d’authentification, mise à jour et suppression. 6 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /integrations/linkedin | Fetch list |
| GET | /integrations/linkedin/{linkedin_account_id} | Find profile |
| POST | /integrations/linkedin | Add a LinkedIn account |
| POST | /integrations/linkedin/{linkedin_account_id}/checkpoint | Solve an authentication checkpoint using a code that you received. If the checkpoint is via the app, you can enter any code you want once validated |
| PUT | /integrations/linkedin/{linkedin_account_id} | Update a LinkedIn account |
| DELETE | /integrations/linkedin/{linkedin_account_id} | Delete a LinkedIn account |
OVH (domaines et e-mails) OVH
Vérification de disponibilité et de prix d’un domaine, commande de domaines et de comptes Email Pro, synchronisation des actifs OVH. 8 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /ovh | Fetch list |
| GET | /ovh/account/{external_api_key_id}/validate-ordering-prerequisites | Check OVH account readiness for ordering |
| GET | /ovh/domain/availability/{domain}/{external_api_key_id} | Check domain availability and price |
| GET | /ovh/sync-assets/{external_api_key_id}/results | Fetch sync-assets job results |
| POST | /ovh/checkout | Order a domain and/or associated email pro accounts |
| POST | /ovh/sync-assets | Sync OVH domains/emails |
| DELETE | /ovh/domain/{domain_id} | Delete an OVH domain |
| DELETE | /ovh/email/{email_id} | Delete an OVH email account |
PRM : CRM de prospection
Le PRM (Prospect Relationship Management) centralise les contacts engagés et leur historique. 57 endpoints.
PRM PRM
Recherche d’un contact par e-mail ou URL LinkedIn, import et export, notes avec pièces jointes, appels, envoi d’invitations et de messages LinkedIn, statuts personnalisés, tags, partages entre utilisateurs, nurturing, exclusion d’un workflow, enrichissement via API externe, qualification positive/négative des réponses et suggestion de réponse générée par IA. 57 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /prm/contact | Find a contact profile by email or LinkedIn URL |
| GET | /prm/contact/{contact_id} | Find a contact profile |
| GET | /prm/contact/{contact_id}/note/{note_id}/attachments | Get note attachments |
| GET | /prm/contact/user/{user_id} | Find a contact profile of a PRM by email or LinkedIn URL |
| GET | /prm/contacts | Fetch the contacts of your PRM |
| GET | /prm/contacts/shared | Fetch the contacts of your PRM that you shared |
| GET | /prm/contacts/user/{user_id} | Fetch contacts of a PRM |
| GET | /prm/contacts/users | Fetch contacts of multiple PRM |
| GET | /prm/list | List visible PRM |
| GET | /prm/notifications/column-entry | Retrieve PRM column-entry notification watchlist |
| GET | /prm/nurturing/{nurturing_id} | Get a PRM nurturing |
| GET | /prm/nurturings | Get PRM nurturings |
| GET | /prm/sharings | Retrieve your PRM sharings |
| GET | /prm/status | Retrieve your PRM statuses |
| GET | /prm/status/custom | Retrieve your PRM custom statuses |
| POST | /prm/contact/{contact_id}/call | Create a PRM call from a contact |
| POST | /prm/contact/{contact_id}/enrich/phone/mobile | Enrich a contact phone number |
| POST | /prm/contact/{contact_id}/exclude/{workflow_id} | Exclude a PRM contact from a workflow |
| POST | /prm/contact/{contact_id}/exclude/programmation/{programmation_id} | Exclude a PRM contact from a programmation |
| POST | /prm/contact/{contact_id}/linkedin/invitation | Send a linkedin invitation to a contact |
| POST | /prm/contact/{contact_id}/linkedin/message | Send a linkedin message to a contact |
| POST | /prm/contact/{contact_id}/note | Create a PRM note from a contact |
| POST | /prm/contact/{contact_id}/note/{note_id}/attachment | Upload note attachments |
| POST | /prm/contact/{contact_id}/programmation/{programmation_id}/step/{step_id} | Manually progress a contact to an event after a call step |
| POST | /prm/contact/{contact_id}/reply/{history_type_reply}/{reply_id}/suggest-reply | Generate a suggested reply using AI |
| POST | /prm/contacts | Import contact into your PRM |
| POST | /prm/contacts/contact-list/{contact_list_id}/add | Add contacts from a PRM to a contact list |
| POST | /prm/contacts/enrich/external/{enrich_external_api}/{external_api_key_id} | Enrich the prm using an external api |
| POST | /prm/contacts/export/{file_type} | Export the contacts of your PRM |
| POST | /prm/contacts/import | Import contacts |
| POST | /prm/contacts/user/{user_id} | Import contact into a PRM |
| POST | /prm/contacts/user/{user_id}/copy/blacklist/{blacklist_id} | Copy PRM contacts to a blacklist |
| POST | /prm/contacts/user/{user_id}/enrich/external/{enrich_external_api}/{external_api_key_id} | Enrich the prm using an external api |
| POST | /prm/contacts/user/{user_id}/export/{file_type} | Export contacts of a PRM |
| POST | /prm/contacts/user/{user_id}/tags | Add tags to contacts of a PRM |
| POST | /prm/nurturing | Create a PRM nurturing |
| POST | /prm/sharings | Create sharing |
| POST | /prm/status/custom | Create a PRM custom status |
| PUT | /prm/contact/{contact_id} | Update a PRM contact |
| PUT | /prm/contact/{contact_id}/note/{note_id} | Update a PRM note from a contact |
| PUT | /prm/contact/{contact_id}/reply/{history_type_reply}/{reply_id} | Mark a contact reply as positive/negative or remove the mark |
| PUT | /prm/contacts/new_reply | Update PRM contacts new reply |
| PUT | /prm/contacts/status | Update PRM contacts statuses |
| PUT | /prm/notifications/column-entry | Replace PRM column-entry notification watchlist |
| PUT | /prm/nurturing/{nurturing_id} | Update a PRM nurturing |
| PUT | /prm/sharings/{sharing_id} | Update sharing |
| PUT | /prm/status/{status} | Update a PRM status |
| PUT | /prm/status/custom/{status_id} | Update a PRM custom status |
| DELETE | /prm/contact/{contact_id}/call/{call_id} | Delete a PRM call from a contact |
| DELETE | /prm/contact/{contact_id}/note/{note_id} | Delete a PRM note from a contact |
| DELETE | /prm/contact/{contact_id}/note/{note_id}/attachment/{attachment_id} | Delete note attachment |
| DELETE | /prm/contacts | Delete contacts from your PRM |
| DELETE | /prm/contacts/user/{user_id} | Delete contacts from a PRM |
| DELETE | /prm/contacts/user/{user_id}/tags | Remove tags from contacts of a PRM |
| DELETE | /prm/nurturing/{nurturing_id} | Delete a PRM nurturing |
| DELETE | /prm/sharings/{sharing_id} | Delete sharing |
| DELETE | /prm/status/custom/{status_id} | Delete a PRM custom status |
Statistiques et reporting
Mesure de la performance des campagnes, du global jusqu’au répondant. 26 endpoints.
Statistiques Statistics
Statistiques globales, par intégration et par programmation, détaillées jour par jour, exportables. Analyse des répondants par canal, pays, région, secteur, taille d’entreprise, tag, propriétaire et statut PRM. 21 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /statistics/global | Fetch global programmations statistics |
| GET | /statistics/integrations | Fetch integrations statistics |
| GET | /statistics/messages | Retrieve the list of possible statistics messages |
| GET | /statistics/programmations | Fetch programmations statistics |
| GET | /statistics/programmations/{programmation_id} | Fetch statistics of a programmation |
| GET | /statistics/programmations/{programmation_id}/download/{file_type} | Download the statistics of a programmation |
| GET | /statistics/programmations/download/{file_type} | Download programmations statistics |
| POST | /statistics/date | Fetch programmation stats by date |
| POST | /statistics/date/contacts | Download programmation contacts by date |
| POST | /statistics/date/detailed | Fetch programmation stats by various parameters, day by day |
| POST | /statistics/global/detailed | Fetch global programmation stats by various parameters |
| POST | /statistics/responders/by-channel-and-status | Responders by channel and PRM status |
| POST | /statistics/responders/by-company-size | Responders by company size |
| POST | /statistics/responders/by-company-size-and-status | Responders by company size and PRM status |
| POST | /statistics/responders/by-country | Responders by country |
| POST | /statistics/responders/by-prm-owner | Responders by PRM contact owner |
| POST | /statistics/responders/by-programmation-and-list | Responders by programmation and contact list |
| POST | /statistics/responders/by-region | Responders by country and region |
| POST | /statistics/responders/by-sector | Responders by activity sector (top 10) |
| POST | /statistics/responders/by-sector-and-status | Responders by activity sector (top 10) and PRM status |
| POST | /statistics/responders/by-tag | Responders by PRM contact tag |
Rapports Reporting
Création et gestion de rapports personnalisés. 5 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /reporting/report/{report_id} | Retrieve a report |
| GET | /reporting/reports | Fetch list of reports |
| POST | /reporting/report | Create a report |
| PUT | /reporting/report/{report_id} | Update report |
| DELETE | /reporting/report/{report_id} | Delete a report |
Automatisation et intégrations tierces
Connexion de Magileads au reste de la stack (CRM, outils no-code, back-office). 22 endpoints.
Webhooks Webhooks
Création, test et gestion de webhooks pour recevoir les événements Magileads. 6 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /webhooks | Fetch list |
| GET | /webhooks/{webhook_id} | Find profile |
| POST | /webhooks | Create a webhook |
| POST | /webhooks/{webhook_id}/test | Test a webhook |
| PUT | /webhooks/{webhook_id} | Update a webhook |
| DELETE | /webhooks/{webhook_id} | Delete a webhook |
Zapier Zapier
Hooks Zapier : création, activation, désactivation, test et envoi. 9 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /zapier | Fetch list |
| GET | /zapier/{zapier_hook_id} | Find profile |
| POST | /zapier | Create a Zapier hook |
| POST | /zapier/{zapier_hook_id}/send | Send a Zapier hook |
| POST | /zapier/{zapier_hook_id}/test | Test a Zapier hook |
| PUT | /zapier/{zapier_hook_id} | Update profile |
| PUT | /zapier/{zapier_hook_id}/activate | Activate a Zapier hook |
| PUT | /zapier/{zapier_hook_id}/deactivate | Deactivate a Zapier hook |
| DELETE | /zapier/{zapier_hook_id} | Delete a Zapier hook |
Crons Crons
Tâches planifiées : création, exécution manuelle et test avec des données fictives. 7 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /crons | Fetch list |
| GET | /crons/{cron_id} | Find profile |
| POST | /crons | Create a cron |
| POST | /crons/{cron_id}/execute | Manually execute a cron |
| POST | /crons/{cron_id}/test | Test a cron with dummy data |
| PUT | /crons/{cron_id} | Update a cron profile |
| DELETE | /crons/{cron_id} | Delete a cron |
Marque blanche (revendeurs)
Endpoints destinés aux revendeurs qui opèrent Magileads sous leur propre marque. 33 endpoints.
Revendeurs Resellers
Profil revendeur par ID ou domaine SaaS, utilisateurs et tags, options, messages transactionnels, vidéos tutoriels, CNAME et rafraîchissement DNS, extension Chrome en marque blanche et clé OpenRouter. 22 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /resellers/{reseller_domain_saas} | Find profile by domain saas |
| GET | /resellers/{reseller_domain_saas}/users | Fetch users list by domain saas |
| GET | /resellers/{reseller_id} | Find profile by ID |
| GET | /resellers/{reseller_id}/download/extension/chrome | Download extension for Chrome |
| GET | /resellers/{reseller_id}/openrouter-api-key | Retrieve the reseller OpenRouter API key |
| GET | /resellers/{reseller_id}/options | Get options of a reseller |
| GET | /resellers/{reseller_id}/tutorial/videos | Get tutorial videos of a reseller |
| GET | /resellers/{reseller_id}/users | Fetch users list by ID |
| GET | /resellers/cnames | Fetch list of our CNAMES |
| GET | /resellers/messages | Get transactionnal base messages |
| GET | /resellers/messages/{reseller_id} | Get transactionnal messages of a reseller, including base messages |
| POST | /resellers | Create a reseller. Users of your reseller will need to use your domain_saas/domain_saas2/domain_saas3/domain_saas4 |
| POST | /resellers/{reseller_id} | Update profile |
| POST | /resellers/{reseller_id}/dns-refresh-requests | DNS refresh requests for reseller domains |
| POST | /resellers/{reseller_id}/messages | Create or update a transactionnal message for a reseller |
| POST | /resellers/{reseller_id}/options | Create or update multiple options for a reseller |
| POST | /resellers/{reseller_id}/tutorial/videos | Create, update or delete multiple tutorial videos for a reseller |
| PUT | /resellers/{reseller_id}/messages/table-columns/prm-digest | Configure table columns for PRM daily digest email |
| PUT | /resellers/{reseller_id}/role/{user_id} | Update the role of an user |
| PUT | /resellers/{reseller_id}/users/{user_id}/tags | Update reseller user tags |
| DELETE | /resellers/{reseller_id} | Delete a reseller |
| DELETE | /resellers/{reseller_id}/users/{user_id} | Delete reseller user |
Revendeurs : Mailgun Resellers – Mailgun
Configuration Mailgun gérée par le revendeur : domaines (création, import, partage, vérification DNS) et statistiques du mois en cours. 11 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /resellers/{reseller_id}/mailgun | Retrieve the reseller Mailgun configuration |
| GET | /resellers/{reseller_id}/mailgun/domains | List visible reseller-managed Mailgun domains |
| GET | /resellers/{reseller_id}/mailgun/domains/{domain_id} | Retrieve a reseller-managed Mailgun domain |
| GET | /resellers/{reseller_id}/mailgun/statistics | Retrieve current-month managed Mailgun statistics |
| POST | /resellers/{reseller_id}/mailgun | Configure reseller-managed Mailgun |
| POST | /resellers/{reseller_id}/mailgun/domain-imports | Import an existing Mailgun domain |
| POST | /resellers/{reseller_id}/mailgun/domains | Create a reseller-managed Mailgun domain |
| POST | /resellers/{reseller_id}/mailgun/domains/{domain_id} | Update managed Mailgun domain ownership and sharing |
| POST | /resellers/{reseller_id}/mailgun/domains/{domain_id}/dns-refresh-requests | Refresh managed Mailgun DNS verification |
| DELETE | /resellers/{reseller_id}/mailgun | Delete the reseller Mailgun configuration |
| DELETE | /resellers/{reseller_id}/mailgun/domains/{domain_id} | Delete or detach a managed Mailgun domain |
Fichiers et dossiers
Stockage de fichiers et organisation en dossiers. 11 endpoints.
Fichiers Files
Upload, recherche, mise à jour et suppression de fichiers. 6 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /files | Fetch list |
| GET | /files/{file_id} | Find profile |
| POST | /files | Upload a file |
| POST | /files/{file_id} | Update profile |
| POST | /files/search | Search files |
| DELETE | /files/{file_id} | Delete a file |
Dossiers Folders
Organisation des ressources en dossiers. 5 endpoints.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /folders | Fetch list |
| GET | /folders/{folder_id} | Find profile |
| POST | /folders | Create a folder |
| PUT | /folders/{folder_id} | Update profile |
| DELETE | /folders/{folder_id} | Delete a folder |
FAQ API Magileads V2 : API Magileads V2
Qu’est-ce que l’API Magileads ?
L’API Magileads est l’interface REST de la plateforme Magileads de prospection multicanale B2B. Décrite au format OpenAPI 3.0 (version 2.0.0), elle expose 505 endpoints couvrant le ciblage LinkedIn et Google Maps, l’enrichissement de contacts, les campagnes e-mail, LinkedIn et SMS, le PRM et les statistiques.
Quelle est l’URL de base de l’API Magileads ?
Toutes les requêtes sont envoyées vers https://app.api-magileads.net. Les réponses sont au format JSON et toutes les dates sont exprimées en GMT.
Comment s’authentifier sur l’API Magileads ?
La méthode la plus simple consiste à transmettre la clé d’API dans l’en-tête HTTP x-api-key. L’API propose aussi un serveur OAuth 2.0 (flux authorization code, rafraîchissement et révocation de jetons) pour les applications tierces.
Peut-on extraire des leads LinkedIn et Sales Navigator via l’API ?
Oui. Le groupe Targeting – LinkedIn compte 27 endpoints d’extraction : recherches LinkedIn et Sales Navigator (personnes et entreprises), connexions, membres de groupes, participants à des événements, visiteurs de profil, likers, commentateurs et repartageurs de posts.
L’API Magileads intègre-t-elle de l’intelligence artificielle ?
Oui. Des endpoints génèrent des modèles d’e-mails (texte et HTML), d’invitations et de messages LinkedIn, des briefs d’agents IA, des workflows complets par agent IA et des suggestions de réponse aux prospects dans le PRM.
Comment connecter Magileads à un CRM ou à un outil no-code ?
Via les webhooks, les hooks Zapier ou en interrogeant directement les endpoints PRM et Contact Lists. Les crons permettent de planifier des traitements récurrents.
L’API Magileads V2 est-elle disponible en marque blanche ?
Oui. Les groupes Resellers et Resellers – Mailgun permettent de gérer une instance en marque blanche : domaine SaaS, CNAME, messages transactionnels, options, utilisateurs et domaines d’envoi Mailgun.
Besoin d’aide pour votre intégration ? Contactez le support technique Magileads à co*****@*******ds.eu.