➜︎ Retour - Menu API, webhooks et mailhooks

API : modifier un client

Menu de la documentation

API

Démarrer Rechercher un client Lister les clients Créer un client Modifier un client La fiche client en JSON Les erreurs OpenAPI et Postman

Webhooks et mailhooks

Fonctionnement Vente : validation Article : stock mis à jour Les webhooks Client

Votre adresse API et votre clé

Adresse API Clé API

Renseignez-les une fois : tous les exemples de ces pages les utilisent, et les boutons « Copier » copient la requête prête à l'emploi. Ils ne quittent pas votre navigateur. La clé n'est gardée que le temps de cette session, sauf si vous cochez cette case : . Dans ce cas, la clé sera aussi conservée dans ce navigateur web. Votre adresse et votre clé sont dans Réglages → API & Make.

Cette page décrit la modification d'un client par l'API. Réglage de l'API : Réglages → API & Make.

PUT/api/V1/client?api_key=VOTRE_CLE

Cette route modifie un client existant. Le corps de la requête est un JSON avec deux parties : sectionRecherche (quel client) et sectionModif (quoi changer). L'en-tête Content-Type: application/json est à joindre. Seul ce qui est envoyé est changé.

Exemple#

Changer le nom de famille et le mobile du client dont l'email est achats@dupont-sarl.fr :

curl -X PUT "ADRESSE_API/api/V1/client?api_key=VOTRE_CLE" \
  -H "Content-Type: application/json" \
  -d '{
    "sectionRecherche": {
      "rechercheType": "lienSocial",
      "recherche": "achats@dupont-sarl.fr"
    },
    "sectionModif": {
      "nom": "Durand",
      "sectionSocial": {
        "sectionMobile": { "mobile": "0698765432" }
      }
    }
  }'

sectionRecherche : quel client#

Obligatoire. Elle a les mêmes critères que la recherche d'un client.

Propriété	Type	Explications
rechercheType	string	code, id, uuid, idExterne, barcode ou lienSocial.
recherche	string	La valeur cherchée.

Si aucun client ne correspond, la réponse est une erreur 404 « aucun client trouvé » et rien n'est modifié.

sectionModif : quoi changer#

Les propriétés sont les mêmes que pour la création : nom, prenom, anniversaire, type, tarif, suivi, compte, uuid, idExterne, et les sections sectionEntreprise, sectionAdresse et sectionNotes. Seules différences : le code-barre et les contacts, qui ont chacun leur section pour décider de remplacer ou d'ajouter.

sectionCodebarre

Propriété	Type	Explications
ean	string	Le code-barre interne : un EAN 8 valide commençant par 8.
eanAdd	boolean	true : on ajoute ce code-barre aux codes existants. false ou absente : il remplace le code-barre existant.

sectionSocial : un contact par sous-section

Chaque contact a sa sous-section, qui contient la valeur, son opt-in et le choix « remplacer ou ajouter ».

Sous-section	Propriétés
sectionEmail	email, emailPub (opt-in), emailAdd
sectionMobile	mobile, mobilePub, mobileAdd
sectionTel	tel, telPub, telAdd
sectionInstagram	instagram, instaPub, instaAdd
sectionTiktok	tiktok, tiktokPub, tiktokAdd
sectionFacebook	facebook, facebookPub, facebookAdd
sectionX	x, xPub, xAdd

Pour chaque contact : la propriété ...Add à true ajoute un contact de plus ; à false ou absente, la valeur remplace le contact existant.

Effacer une valeur#

Pour vider une valeur (une note, une adresse, un contact, l'idExterne, l'anniversaire, le vendeur de suivi, le tarif...), envoyez la valeur spéciale "-----" (cinq tirets). Une propriété absente n'est pas touchée ; une propriété envoyée avec un texte vide n'efface pas non plus la valeur.

La réponse#

Code 200 : le client est modifié.

{
  "uuid": "38D13BD6-4836-4115-B829-B55AC2537B09",
  "ean": "80003128",
  "id": 312,
  "idExterne": "CRM-4821",
  "code": "312",
  "clientModifie": true
}

Les propriétés sont celles de la création (avec clientModifie au lieu de clientCree). Les erreurs sont dans Les erreurs de l'API.

← PrécédentCréer un client Suivant →La fiche client en JSON

Dernière mise à jour : 13 octobre 2026

Retour - Sommaire - Centre d'aide - Assistance