Créer et mettre à jour un client

  • Customers
  • Compte client
  • 3 routes
Comment créer un client puis compléter son profil ?

Ce scénario explique comment créer un compte client, relire le profil obtenu puis mettre à jour les informations nécessaires à la suite du parcours. Il convient aux usages CRM, vente assistée et onboarding qui doivent sécuriser une fiche client réutilisable avant un devis ou une réservation.

Le flux commence par la création du client, réutilise le customer_id retourné puis relit et met à jour le profil de manière contrôlée.

Vue d'ensemble

Ce scénario aide une application à créer un compte client puis à enrichir immédiatement son profil.

Prérequis

  • Un contexte d'authentification valide avec authorization, accept-language et x-api-key.
  • Les données d'identité et de contact nécessaires à la création du client.
  • Le customer_id retourné par la création pour poursuivre le flux.

Résultat attendu

L'application crée un compte client réutilisable, vérifie le profil obtenu et met à jour les informations utiles pour les étapes de vente ou de réservation suivantes.

Process workflow

Legend:
Obligatoire
Optionnel
1

Creer un nouveau client

Obligatoire

Utilisez POST/v1/customers pour creer un compte client avant de consulter puis d'enrichir son profil. Cette etape retourne le customer_id qui sera reutilise dans les etapes suivantes.

Prerequis

  • Envoyer accept-language, authorization et x-api-key.
  • Preparer les informations d'identite et de contact requises par votre parcours d'onboarding.
  • Ajouter force_address uniquement si votre integration doit contourner la validation d'adresse standard.

Calling CURL

curl -X 'POST' \
  'https://api.clubmed.com/v1/customers' \
  -H 'accept: application/json' \
  -H 'accept-language: fr-FR' \
  -H 'authorization: Bearer YOUR_TOKEN' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Example answer

{
  "id": "123456789",
  "gm_number": "987654321",
  "email": "tom@example.com",
  "identity": {
    "first_name": "Tom",
    "last_name": "Smith"
  },
  "locale": "fr-FR"
}

info: Conservez le customer_id retourne car il devient la cle de reference pour les etapes de lecture et de mise a jour du profil.

Codes de reponse

  • OK Response (201): le client a ete cree et les nouveaux identifiants du compte sont retournes.
  • Error (400): le payload est invalide ou un champ obligatoire est manquant.
  • Error (401): l'authentification est absente, invalide ou expiree.
  • Error (404): non documente dans le Swagger.
POST/v1/customers
Voir plus
2

Obtenir le profil complet du client

Obligatoire

Utilisez GET/v2/customers/{customer_id}/profile pour lire le profil client complet apres la creation ou avant une mise a jour. Cette etape expose l'identite, les contacts, la fidelite et la locale du compte.

Prerequis

  • Reutiliser un customer_id valide.
  • Envoyer accept-language, authorization et x-api-key.
  • Verifier que le contexte authentifie est autorise a consulter ce profil client.

Calling CURL

curl -X 'GET' \
  'https://api.clubmed.com/v2/customers/123456789/profile' \
  -H 'accept: application/json' \
  -H 'accept-language: fr-FR' \
  -H 'authorization: Bearer YOUR_TOKEN' \
  -H 'x-api-key: YOUR_API_KEY'

Example answer

{
  "email": "tom@example.com",
  "gm_number": "123456789",
  "first_name": "Tom",
  "last_name": "Smith",
  "phones": [
    {
      "number": "0623456789",
      "type": "MOBILE"
    }
  ],
  "loyalty_program": {
    "status": "EXCLUDED",
    "points": 1200
  },
  "locale": "fr-FR"
}

info: v2 est le payload de reference pour verifier les contacts et le contexte de fidelite avant une mise a jour.

Codes de reponse

  • OK Response (200): retourne le profil client detaille du compte selectionne.
  • Error (400): la validation de la requete echoue ou une valeur d'entree est mal formee.
  • Error (401): l'authentification est absente, invalide ou expiree.
  • Error (403): l'acces a ce profil client est interdit dans le contexte courant.
  • Error (404): le profil client est introuvable.
GET/v2/customers/{customer_id}/profile
Voir plus
3

Mettre a jour le profil du client

Obligatoire

Utilisez PATCH/v1/customers/{customer_id}/profile pour mettre a jour uniquement les champs clients qui doivent changer. Les champs absents ou undefined sont ignores, tandis que null ou une chaine vide effacent la valeur existante.

Prerequis

  • Reutiliser un customer_id valide.
  • Envoyer accept-language, authorization et x-api-key.
  • Preparer uniquement les champs qui doivent reellement etre modifies.

Calling CURL

curl -X 'PATCH' \
  'https://api.clubmed.com/v1/customers/123456789/profile' \
  -H 'accept: application/json' \
  -H 'accept-language: fr-FR' \
  -H 'authorization: Bearer YOUR_TOKEN' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Example answer

HTTP/1.1 204 No Content

info: Utilisez null ou une chaine vide uniquement lorsque vous souhaitez explicitement vider une valeur de profil existante.

Codes de reponse

  • OK Response (204): le profil client a ete mis a jour avec succes sans corps de reponse.
  • Error (400): le payload est invalide ou un champ soumis ne respecte pas les regles de la route.
  • Error (401): l'authentification est absente, invalide ou expiree.
  • Error (403): l'acces a ce profil client est interdit dans le contexte courant.
  • Error (404): le profil client est introuvable.
PATCH/v1/customers/{customer_id}/profile
Voir plus