logo

Documentation API

Identification

Identification

Webhooks (GET)

Ajout à une listeRetrait d'une listeNouveaux contactsContacts modifiésContacts supprimésNouvelles structuresStructures modifiéesStructures supprimées

Actions (POST)

Créer un contactModifier un contactSupprimer un contactRechercher un contactCréer une structureModifier une structureSupprimer une structure

Documentation API - NextLead CRM

Documentation complète de l'API d'automatisation pour intégrer les fonctionnalités avec des services externes.

Identification

Cette route permet de vérifier la validité de votre clé API et d'identifier votre organisation.

GET/api/zapier/identify-user

Réponse en cas de succès :

{
  "status": 200,
  "data": {
    "name": "Nom de votre organisation"
  }
}

Erreurs possibles :

401Clé API d'automatisation manquante ou invalide
404Organisation non trouvée

Webhooks (GET)

Ajout à une liste

Cette route permet de recevoir une notification lorsqu'un contact est ajouté à une liste de diffusion.

GET/api/zapier/polling/email/added-to-list

Réponse en cas de succès :

{
  "status": 200,
  "data": {
    "id": "id_du_contact",
    "contactData": {
      "email": "contact@exemple.com",
      "firstName": "Jean",
      "lastName": "Dupont"
    },
    "createdAt": "2024-01-01T12:00:00Z"
  }
}

Erreurs possibles :

401Clé API d'automatisation manquante ou invalide
404Organisation non trouvée

Retrait d'une liste

Cette route permet de recevoir une notification lorsqu'un contact est retiré d'une liste de diffusion.

GET/api/zapier/polling/email/deleted-from-list

Réponse en cas de succès :

{
  "status": 200,
  "data": {
    "id": "id_du_contact",
    "contactData": {
      "email": "contact@exemple.com",
      "firstName": "Jean",
      "lastName": "Dupont"
    },
    "createdAt": "2024-01-01T12:00:00Z"
  }
}

Erreurs possibles :

401Clé API d'automatisation manquante ou invalide
404Organisation non trouvée

Nouveaux contacts

Cette route permet de récupérer les nouveaux contacts créés.

GET/api/zapier/polling/contact/user-created

Réponse en cas de succès :

{
  "status": 200,
  "data": [
    {
      "id": "id_du_contact",
      "email": "contact@exemple.com",
      "firstName": "Jean",
      "lastName": "Dupont",
      "created_at": "2024-01-01T12:00:00Z",
      "organization_id": "id_de_l_organisation"
    }
  ]
}

Erreurs possibles :

401Clé API d'automatisation manquante ou invalide
404Organisation non trouvée

Contacts modifiés

Cette route permet de récupérer les contacts qui ont été modifiés.

GET/api/zapier/polling/contact/user-edited

Réponse en cas de succès :

{
  "status": 200,
  "data": [
    {
      "id": "id_du_contact",
      "email": "contact@exemple.com",
      "firstName": "Jean",
      "lastName": "Dupont",
      "updated_at": "2024-01-01T12:00:00Z"
    }
  ]
}

Erreurs possibles :

401Clé API d'automatisation manquante ou invalide
404Organisation non trouvée

Contacts supprimés

Cette route permet de récupérer les contacts qui ont été supprimés.

GET/api/zapier/polling/contact/user-deleted

Réponse en cas de succès :

{
  "status": 200,
  "data": [
    {
      "id": "id_du_contact",
      "email": "contact@exemple.com",
      "firstName": "Jean",
      "lastName": "Dupont",
      "deleted_at": "2024-01-01T12:00:00Z"
    }
  ]
}

Erreurs possibles :

401Clé API d'automatisation manquante ou invalide
404Organisation non trouvée

Nouvelles structures

Cette route permet de récupérer les nouvelles structures créées.

GET/api/zapier/polling/structures/structure-created

Réponse en cas de succès :

{
  "status": 200,
  "data": [
    {
      "id": "id_de_la_structure",
      "name": "Nom de la structure",
      "created_at": "2024-01-01T12:00:00Z"
    }
  ]
}

Erreurs possibles :

401Clé API d'automatisation manquante ou invalide
404Organisation non trouvée

Structures modifiées

Cette route permet de récupérer les structures qui ont été modifiées.

GET/api/zapier/polling/structures/structure-edited

Réponse en cas de succès :

{
  "status": 200,
  "data": [
    {
      "id": "id_de_la_structure",
      "name": "Nom de la structure",
      "updated_at": "2024-01-01T12:00:00Z"
    }
  ]
}

Erreurs possibles :

401Clé API d'automatisation manquante ou invalide
404Organisation non trouvée

Structures supprimées

Cette route permet de récupérer les structures qui ont été supprimées.

GET/api/zapier/polling/structures/structure-deleted

Réponse en cas de succès :

{
  "status": 200,
  "data": [
    {
      "id": "id_de_la_structure",
      "name": "Nom de la structure",
      "deleted_at": "2024-01-01T12:00:00Z"
    }
  ]
}

Erreurs possibles :

401Clé API d'automatisation manquante ou invalide
404Organisation non trouvée

Actions (POST)

Créer un contact

Cette route permet de créer un nouveau contact dans votre organisation.

POST/api/zapier/receive/contact/new-contact

Corps de la requête :

{
  "firstName": "Prénom",
  "lastName": "Nom",
  "email": "email@exemple.com",
  "phone": "0123456789"
}

Réponse en cas de succès :

{
  "status": 201,
  "data": {
    "id": "id_du_contact",
    "firstName": "Prénom",
    "lastName": "Nom",
    "email": "email@exemple.com",
    "phone": "0123456789",
    "createdAt": "2024-01-01T12:00:00Z"
  }
}

Erreurs possibles :

400Données invalides ou manquantes
401Clé API d'automatisation manquante ou invalide
404Organisation non trouvée

Modifier un contact

Cette route permet de modifier un contact existant dans votre organisation.

POST/api/zapier/receive/contact/edited-contact

Corps de la requête :

{
  "id": "id_du_contact",
  "firstName": "Prénom",
  "lastName": "Nom",
  "email": "email@exemple.com",
  "phone": "0123456789"
}

Réponse en cas de succès :

{
  "status": 200,
  "data": {
    "id": "id_du_contact",
    "firstName": "Prénom",
    "lastName": "Nom",
    "email": "email@exemple.com",
    "phone": "0123456789",
    "updatedAt": "2024-01-01T12:00:00Z"
  }
}

Erreurs possibles :

400Données invalides ou manquantes
401Clé API d'automatisation manquante ou invalide
404Contact ou organisation non trouvé

Supprimer un contact

Cette route permet de supprimer un contact existant dans votre organisation.

DELETE/api/zapier/receive/contact/delete-contact

Corps de la requête :

{
  "id": "id_du_contact"
}

Réponse en cas de succès :

{
  "status": 200,
  "data": {
    "message": "Contact supprimé avec succès",
    "deletedAt": "2024-01-01T12:00:00Z"
  }
}

Erreurs possibles :

400ID du contact manquant
401Clé API d'automatisation manquante ou invalide
404Contact ou organisation non trouvé

Rechercher un contact

Cette route permet de rechercher un contact existant par son email.

POST/api/zapier/receive/contact/find-contact

Corps de la requête :

{
  "email": "email@exemple.com"
}

Réponse en cas de succès :

{
  "status": 200,
  "data": [
    {
      "found": true,
      "id": "id_du_contact",
      "email": "email@exemple.com",
      "firstName": "Jean",
      "lastName": "Dupont"
    }
  ]
}

Erreurs possibles :

400Corps de la requête invalide ou vide
401Clé API d'automatisation manquante ou invalide
404Organisation non trouvée

Créer une structure

Cette route permet de créer une nouvelle structure dans votre organisation.

POST/api/zapier/receive/structure/create-structure

Corps de la requête :

{
  "name": "Nom de la structure",
  "email": "email@exemple.com",
  "phone": "0123456789",
  "address": "123 rue exemple",
  "city": "Ville",
  "zipCode": "75000",
  "country": "France",
  "website": "https://www.exemple.com"
}

Réponse en cas de succès :

{
  "status": 200,
  "data": {
    "id": "id_de_la_structure",
    "name": "Nom de la structure",
    "email": "email@exemple.com",
    "phone": "0123456789",
    "address": "123 rue exemple",
    "city": "Ville",
    "zipCode": "75000",
    "country": "France",
    "website": "https://www.exemple.com",
    "createdAt": "2024-01-01T12:00:00Z"
  }
}

Erreurs possibles :

400Données invalides ou manquantes
401Clé API d'automatisation manquante ou invalide

Modifier une structure

Cette route permet de mettre à jour une structure existante dans votre organisation.

POST/api/zapier/receive/structure/update-structure

Corps de la requête :

{
  "id": "id_de_la_structure",
  "name": "Nouveau nom de la structure",
  "email": "nouveau@exemple.com",
  "phone": "0123456789",
  "address": "123 rue exemple",
  "city": "Ville",
  "zipCode": "75000",
  "country": "France",
  "website": "https://www.exemple.com"
}

Réponse en cas de succès :

{
  "status": 200,
  "data": {
    "id": "id_de_la_structure",
    "name": "Nouveau nom de la structure",
    "email": "nouveau@exemple.com",
    "phone": "0123456789",
    "address": "123 rue exemple",
    "city": "Ville",
    "zipCode": "75000",
    "country": "France",
    "website": "https://www.exemple.com",
    "updatedAt": "2024-01-01T12:00:00Z"
  }
}

Erreurs possibles :

400Données invalides ou manquantes
401Clé API d'automatisation manquante ou invalide
404Structure non trouvée

Supprimer une structure

Cette route permet de supprimer une structure existante dans votre organisation.

POST/api/zapier/receive/structure/delete-structure

Corps de la requête :

{
  "id": "id_de_la_structure"
}

Réponse en cas de succès :

{
  "status": 200,
  "data": {
    "message": "Structure supprimée avec succès",
    "deletedAt": "2024-01-01T12:00:00Z"
  }
}

Erreurs possibles :

400ID de la structure manquant
401Clé API d'automatisation manquante ou invalide
404Structure non trouvée